openapi: 3.0.1 info: title: Palantir OpenAPI description: The Palantir REST API. Please see https://www.palantir.com/docs for more details. version: 3.0.1 externalDocs: description: API Documentation url: https://www.palantir.com/docs servers: - url: https://ptukhealth.palantirfoundry.co.uk paths: /api/v2/ontologies/palantirukhealth-ontology/objects/Admission: get: tags: - AdmissionApiService operationId: admissionListAdmission 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/Osdk.AdmissionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAdmissionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/aggregate: post: tags: - AdmissionApiService operationId: admissionComputeAdmissionAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/count: post: tags: - AdmissionApiService operationId: admissionComputeAdmissionCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/search: post: tags: - AdmissionApiService operationId: admissionSearchAdmission parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchAdmissionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}: get: tags: - AdmissionApiService operationId: admissionGetAdmission parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.AdmissionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Admission" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/births: get: tags: - AdmissionApiService operationId: admissionListAdmissionLinkedBirths 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/Osdk.AdmissionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBirthResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/births/{linkedObjectPrimaryKey}: get: tags: - AdmissionApiService operationId: admissionGetAdmissionLinkedBirths 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/Osdk.AdmissionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Admission.Birth" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/consultantEpisodes: get: tags: - AdmissionApiService operationId: admissionListAdmissionLinkedConsultantEpisodes 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/Osdk.AdmissionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListConsultantEpisodeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/consultantEpisodes/{linkedObjectPrimaryKey}: get: tags: - AdmissionApiService operationId: admissionGetAdmissionLinkedConsultantEpisodes 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/Osdk.AdmissionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Admission.ConsultantEpisode" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/criticalCarePeriods: get: tags: - AdmissionApiService operationId: admissionListAdmissionLinkedCriticalCarePeriods 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/Osdk.AdmissionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCriticalCarePeriodResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/criticalCarePeriods/{linkedObjectPrimaryKey}: get: tags: - AdmissionApiService operationId: admissionGetAdmissionLinkedCriticalCarePeriods 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/Osdk.AdmissionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Admission.CriticalCarePeriod" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/emed3fitNotes: get: tags: - AdmissionApiService operationId: admissionListAdmissionLinkedEmed3fitNotes 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/Osdk.AdmissionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEMed3FitNoteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/emed3fitNotes/{linkedObjectPrimaryKey}: get: tags: - AdmissionApiService operationId: admissionGetAdmissionLinkedEmed3fitNotes 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/Osdk.AdmissionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Admission.EMed3FitNote" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/homeLeaves: get: tags: - AdmissionApiService operationId: admissionListAdmissionLinkedHomeLeaves 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/Osdk.AdmissionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListHomeLeaveResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/homeLeaves/{linkedObjectPrimaryKey}: get: tags: - AdmissionApiService operationId: admissionGetAdmissionLinkedHomeLeaves 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/Osdk.AdmissionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Admission.HomeLeave" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/incomingTransferOfCareRequest: get: tags: - AdmissionApiService operationId: admissionListAdmissionLinkedIncomingTransferOfCareRequest 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/Osdk.AdmissionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTransferOfCareRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/incomingTransferOfCareRequest/{linkedObjectPrimaryKey} : get: tags: - AdmissionApiService operationId: admissionGetAdmissionLinkedIncomingTransferOfCareRequest 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/Osdk.AdmissionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Admission.TransferOfCareRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/labour: get: tags: - AdmissionApiService operationId: admissionListAdmissionLinkedLabour 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/Osdk.AdmissionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListLabourResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/labour/{linkedObjectPrimaryKey}: get: tags: - AdmissionApiService operationId: admissionGetAdmissionLinkedLabour 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/Osdk.AdmissionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Admission.Labour" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/outgoingTransferOfCareRequests: get: tags: - AdmissionApiService operationId: admissionListAdmissionLinkedOutgoingTransferOfCareRequests 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/Osdk.AdmissionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTransferOfCareRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/outgoingTransferOfCareRequests/{linkedObjectPrimaryKey} : get: tags: - AdmissionApiService operationId: admissionGetAdmissionLinkedOutgoingTransferOfCareRequests 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/Osdk.AdmissionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Admission.TransferOfCareRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/patient: get: tags: - AdmissionApiService operationId: admissionListAdmissionLinkedPatient 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/Osdk.AdmissionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - AdmissionApiService operationId: admissionGetAdmissionLinkedPatient 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/Osdk.AdmissionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Admission.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/scoredAssessments: get: tags: - AdmissionApiService operationId: admissionListAdmissionLinkedScoredAssessments 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/Osdk.AdmissionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListScoredAssessmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/scoredAssessments/{linkedObjectPrimaryKey}: get: tags: - AdmissionApiService operationId: admissionGetAdmissionLinkedScoredAssessments 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/Osdk.AdmissionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Admission.ScoredAssessment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/wardStays: get: tags: - AdmissionApiService operationId: admissionListAdmissionLinkedWardStays 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/Osdk.AdmissionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListWardStayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Admission/{primaryKey}/links/wardStays/{linkedObjectPrimaryKey}: get: tags: - AdmissionApiService operationId: admissionGetAdmissionLinkedWardStays 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/Osdk.AdmissionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Admission.WardStay" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment: get: tags: - AppointmentApiService operationId: appointmentListAppointment 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/Osdk.AppointmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAppointmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/aggregate: post: tags: - AppointmentApiService operationId: appointmentComputeAppointmentAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/count: post: tags: - AppointmentApiService operationId: appointmentComputeAppointmentCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/search: post: tags: - AppointmentApiService operationId: appointmentSearchAppointment parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchAppointmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}: get: tags: - AppointmentApiService operationId: appointmentGetAppointment parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.AppointmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Appointment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/assignedCareProfessionals: get: tags: - AppointmentApiService operationId: appointmentListAppointmentLinkedAssignedCareProfessionals 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/Osdk.AppointmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAssignedCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/assignedCareProfessionals/{linkedObjectPrimaryKey} : get: tags: - AppointmentApiService operationId: appointmentGetAppointmentLinkedAssignedCareProfessionals 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/Osdk.AppointmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Appointment.AssignedCareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/clinicLetter: get: tags: - AppointmentApiService operationId: appointmentListAppointmentLinkedClinicLetter 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/Osdk.AppointmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicLetterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/clinicLetter/{linkedObjectPrimaryKey}: get: tags: - AppointmentApiService operationId: appointmentGetAppointmentLinkedClinicLetter 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/Osdk.AppointmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Appointment.ClinicLetter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/clinicSession: get: tags: - AppointmentApiService operationId: appointmentListAppointmentLinkedClinicSession 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/Osdk.AppointmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/clinicSession/{linkedObjectPrimaryKey}: get: tags: - AppointmentApiService operationId: appointmentGetAppointmentLinkedClinicSession 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/Osdk.AppointmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Appointment.ClinicSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/emed3fitNotes: get: tags: - AppointmentApiService operationId: appointmentListAppointmentLinkedEmed3fitNotes 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/Osdk.AppointmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEMed3FitNoteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/emed3fitNotes/{linkedObjectPrimaryKey}: get: tags: - AppointmentApiService operationId: appointmentGetAppointmentLinkedEmed3fitNotes 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/Osdk.AppointmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Appointment.EMed3FitNote" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/patient: get: tags: - AppointmentApiService operationId: appointmentListAppointmentLinkedPatient 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/Osdk.AppointmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - AppointmentApiService operationId: appointmentGetAppointmentLinkedPatient 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/Osdk.AppointmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Appointment.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/referral: get: tags: - AppointmentApiService operationId: appointmentListAppointmentLinkedReferral 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/Osdk.AppointmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListReferralResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/referral/{linkedObjectPrimaryKey}: get: tags: - AppointmentApiService operationId: appointmentGetAppointmentLinkedReferral 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/Osdk.AppointmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Appointment.Referral" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/scoredAssessments: get: tags: - AppointmentApiService operationId: appointmentListAppointmentLinkedScoredAssessments 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/Osdk.AppointmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListScoredAssessmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Appointment/{primaryKey}/links/scoredAssessments/{linkedObjectPrimaryKey}: get: tags: - AppointmentApiService operationId: appointmentGetAppointmentLinkedScoredAssessments 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/Osdk.AppointmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Appointment.ScoredAssessment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/AssignedCareProfessional: get: tags: - AssignedCareProfessionalApiService operationId: assignedCareProfessionalListAssignedCareProfessional 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/Osdk.AssignedCareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAssignedCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/AssignedCareProfessional/aggregate: post: tags: - AssignedCareProfessionalApiService operationId: assignedCareProfessionalComputeAssignedCareProfessionalAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/AssignedCareProfessional/count: post: tags: - AssignedCareProfessionalApiService operationId: assignedCareProfessionalComputeAssignedCareProfessionalCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/AssignedCareProfessional/search: post: tags: - AssignedCareProfessionalApiService operationId: assignedCareProfessionalSearchAssignedCareProfessional parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchAssignedCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/AssignedCareProfessional/{primaryKey}: get: tags: - AssignedCareProfessionalApiService operationId: assignedCareProfessionalGetAssignedCareProfessional parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.AssignedCareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.AssignedCareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/AssignedCareProfessional/{primaryKey}/links/appointment: get: tags: - AssignedCareProfessionalApiService operationId: assignedCareProfessionalListAssignedCareProfessionalLinkedAppointment 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/Osdk.AssignedCareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAppointmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/AssignedCareProfessional/{primaryKey}/links/appointment/{linkedObjectPrimaryKey} : get: tags: - AssignedCareProfessionalApiService operationId: assignedCareProfessionalGetAssignedCareProfessionalLinkedAppointment 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/Osdk.AssignedCareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/AssignedCareProfessional.Appointment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/AssignedCareProfessional/{primaryKey}/links/careProfessional: get: tags: - AssignedCareProfessionalApiService operationId: assignedCareProfessionalListAssignedCareProfessionalLinkedCareProfessional 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/Osdk.AssignedCareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/AssignedCareProfessional/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey} : get: tags: - AssignedCareProfessionalApiService operationId: assignedCareProfessionalGetAssignedCareProfessionalLinkedCareProfessional 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/Osdk.AssignedCareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/AssignedCareProfessional.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/AssignedCareProfessional/{primaryKey}/links/consultantEpisode: get: tags: - AssignedCareProfessionalApiService operationId: assignedCareProfessionalListAssignedCareProfessionalLinkedConsultantEpisode 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/Osdk.AssignedCareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListConsultantEpisodeResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/AssignedCareProfessional/{primaryKey}/links/consultantEpisode/{linkedObjectPrimaryKey} : get: tags: - AssignedCareProfessionalApiService operationId: assignedCareProfessionalGetAssignedCareProfessionalLinkedConsultantEpisode 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/Osdk.AssignedCareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/AssignedCareProfessional.ConsultantEpisode" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/AssignedCareProfessional/{primaryKey}/links/uecAttendance: get: tags: - AssignedCareProfessionalApiService operationId: assignedCareProfessionalListAssignedCareProfessionalLinkedUecAttendance 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/Osdk.AssignedCareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUecAttendanceResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/AssignedCareProfessional/{primaryKey}/links/uecAttendance/{linkedObjectPrimaryKey} : get: tags: - AssignedCareProfessionalApiService operationId: assignedCareProfessionalGetAssignedCareProfessionalLinkedUecAttendance 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/Osdk.AssignedCareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/AssignedCareProfessional.UecAttendance" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Birth: get: tags: - BirthApiService operationId: birthListBirth 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/Osdk.BirthProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBirthResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Birth/aggregate: post: tags: - BirthApiService operationId: birthComputeBirthAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Birth/count: post: tags: - BirthApiService operationId: birthComputeBirthCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Birth/search: post: tags: - BirthApiService operationId: birthSearchBirth parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchBirthResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Birth/{primaryKey}: get: tags: - BirthApiService operationId: birthGetBirth parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.BirthProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Birth" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Birth/{primaryKey}/links/admission: get: tags: - BirthApiService operationId: birthListBirthLinkedAdmission 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/Osdk.BirthProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAdmissionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Birth/{primaryKey}/links/admission/{linkedObjectPrimaryKey}: get: tags: - BirthApiService operationId: birthGetBirthLinkedAdmission 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/Osdk.BirthProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Birth.Admission" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Birth/{primaryKey}/links/labour: get: tags: - BirthApiService operationId: birthListBirthLinkedLabour 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/Osdk.BirthProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListLabourResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Birth/{primaryKey}/links/labour/{linkedObjectPrimaryKey}: get: tags: - BirthApiService operationId: birthGetBirthLinkedLabour 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/Osdk.BirthProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Birth.Labour" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Birth/{primaryKey}/links/patient: get: tags: - BirthApiService operationId: birthListBirthLinkedPatient 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/Osdk.BirthProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Birth/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - BirthApiService operationId: birthGetBirthLinkedPatient 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/Osdk.BirthProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Birth.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Birth/{primaryKey}/links/pregnancy: get: tags: - BirthApiService operationId: birthListBirthLinkedPregnancy 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/Osdk.BirthProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPregnancyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Birth/{primaryKey}/links/pregnancy/{linkedObjectPrimaryKey}: get: tags: - BirthApiService operationId: birthGetBirthLinkedPregnancy 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/Osdk.BirthProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Birth.Pregnancy" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest: get: tags: - BookingRequestApiService operationId: bookingRequestListBookingRequest 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/Osdk.BookingRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBookingRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/aggregate: post: tags: - BookingRequestApiService operationId: bookingRequestComputeBookingRequestAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/count: post: tags: - BookingRequestApiService operationId: bookingRequestComputeBookingRequestCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/search: post: tags: - BookingRequestApiService operationId: bookingRequestSearchBookingRequest parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchBookingRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}: get: tags: - BookingRequestApiService operationId: bookingRequestGetBookingRequest parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.BookingRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.BookingRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/bookingRequestComment: get: tags: - BookingRequestApiService operationId: bookingRequestListBookingRequestLinkedBookingRequestComment 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/Osdk.BookingRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBookingRequestCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/bookingRequestComment/{linkedObjectPrimaryKey} : get: tags: - BookingRequestApiService operationId: bookingRequestGetBookingRequestLinkedBookingRequestComment 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/Osdk.BookingRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/BookingRequest.BookingRequestComment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/careProfessional: get: tags: - BookingRequestApiService operationId: bookingRequestListBookingRequestLinkedCareProfessional 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/Osdk.BookingRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey} : get: tags: - BookingRequestApiService operationId: bookingRequestGetBookingRequestLinkedCareProfessional 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/Osdk.BookingRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/BookingRequest.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/careProfessionalPrimaryConsultant: get: tags: - BookingRequestApiService operationId: bookingRequestListBookingRequestLinkedCareProfessionalPrimaryConsultant 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/Osdk.BookingRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/careProfessionalPrimaryConsultant/{linkedObjectPrimaryKey} : get: tags: - BookingRequestApiService operationId: bookingRequestGetBookingRequestLinkedCareProfessionalPrimaryConsultant 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/Osdk.BookingRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/BookingRequest.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/encounter: get: tags: - BookingRequestApiService operationId: bookingRequestListBookingRequestLinkedEncounter 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/Osdk.BookingRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}: get: tags: - BookingRequestApiService operationId: bookingRequestGetBookingRequestLinkedEncounter 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/Osdk.BookingRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/BookingRequest.Encounter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/patient: get: tags: - BookingRequestApiService operationId: bookingRequestListBookingRequestLinkedPatient 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/Osdk.BookingRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - BookingRequestApiService operationId: bookingRequestGetBookingRequestLinkedPatient 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/Osdk.BookingRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/BookingRequest.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/specialty: get: tags: - BookingRequestApiService operationId: bookingRequestListBookingRequestLinkedSpecialty 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/Osdk.BookingRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSpecialtyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}: get: tags: - BookingRequestApiService operationId: bookingRequestGetBookingRequestLinkedSpecialty 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/Osdk.BookingRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/BookingRequest.Specialty" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/theatreBooking: get: tags: - BookingRequestApiService operationId: bookingRequestListBookingRequestLinkedTheatreBooking 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/Osdk.BookingRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreBookingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/theatreBooking/{linkedObjectPrimaryKey}: get: tags: - BookingRequestApiService operationId: bookingRequestGetBookingRequestLinkedTheatreBooking 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/Osdk.BookingRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/BookingRequest.TheatreBooking" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/theatreSession: get: tags: - BookingRequestApiService operationId: bookingRequestListBookingRequestLinkedTheatreSession 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/Osdk.BookingRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequest/{primaryKey}/links/theatreSession/{linkedObjectPrimaryKey}: get: tags: - BookingRequestApiService operationId: bookingRequestGetBookingRequestLinkedTheatreSession 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/Osdk.BookingRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/BookingRequest.TheatreSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequestComment: get: tags: - BookingRequestCommentApiService operationId: bookingRequestCommentListBookingRequestComment 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/Osdk.BookingRequestCommentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBookingRequestCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequestComment/aggregate: post: tags: - BookingRequestCommentApiService operationId: bookingRequestCommentComputeBookingRequestCommentAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequestComment/count: post: tags: - BookingRequestCommentApiService operationId: bookingRequestCommentComputeBookingRequestCommentCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequestComment/search: post: tags: - BookingRequestCommentApiService operationId: bookingRequestCommentSearchBookingRequestComment parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchBookingRequestCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequestComment/{primaryKey}: get: tags: - BookingRequestCommentApiService operationId: bookingRequestCommentGetBookingRequestComment parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.BookingRequestCommentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.BookingRequestComment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequestComment/{primaryKey}/links/bookingRequest: get: tags: - BookingRequestCommentApiService operationId: bookingRequestCommentListBookingRequestCommentLinkedBookingRequest 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/Osdk.BookingRequestCommentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBookingRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/BookingRequestComment/{primaryKey}/links/bookingRequest/{linkedObjectPrimaryKey} : get: tags: - BookingRequestCommentApiService operationId: bookingRequestCommentGetBookingRequestCommentLinkedBookingRequest 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/Osdk.BookingRequestCommentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/BookingRequestComment.BookingRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway: get: tags: - CancerPathwayApiService operationId: cancerPathwayListCancerPathway 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/Osdk.CancerPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCancerPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/aggregate: post: tags: - CancerPathwayApiService operationId: cancerPathwayComputeCancerPathwayAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/count: post: tags: - CancerPathwayApiService operationId: cancerPathwayComputeCancerPathwayCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/search: post: tags: - CancerPathwayApiService operationId: cancerPathwaySearchCancerPathway parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchCancerPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/{primaryKey}: get: tags: - CancerPathwayApiService operationId: cancerPathwayGetCancerPathway parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.CancerPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.CancerPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/{primaryKey}/links/cancerTrackingComments: get: tags: - CancerPathwayApiService operationId: cancerPathwayListCancerPathwayLinkedCancerTrackingComments 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/Osdk.CancerPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCancerTrackingCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/{primaryKey}/links/cancerTrackingComments/{linkedObjectPrimaryKey} : get: tags: - CancerPathwayApiService operationId: cancerPathwayGetCancerPathwayLinkedCancerTrackingComments 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/Osdk.CancerPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CancerPathway.CancerTrackingComment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/{primaryKey}/links/interProviderTransfers: get: tags: - CancerPathwayApiService operationId: cancerPathwayListCancerPathwayLinkedInterProviderTransfers 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/Osdk.CancerPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListInterProviderTransferResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/{primaryKey}/links/interProviderTransfers/{linkedObjectPrimaryKey} : get: tags: - CancerPathwayApiService operationId: cancerPathwayGetCancerPathwayLinkedInterProviderTransfers 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/Osdk.CancerPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CancerPathway.InterProviderTransfer" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/{primaryKey}/links/mdtMeetings: get: tags: - CancerPathwayApiService operationId: cancerPathwayListCancerPathwayLinkedMdtMeetings 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/Osdk.CancerPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListMdtMeetingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/{primaryKey}/links/mdtMeetings/{linkedObjectPrimaryKey}: get: tags: - CancerPathwayApiService operationId: cancerPathwayGetCancerPathwayLinkedMdtMeetings 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/Osdk.CancerPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CancerPathway.mdtMeeting" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/{primaryKey}/links/mdtNotes: get: tags: - CancerPathwayApiService operationId: cancerPathwayListCancerPathwayLinkedMdtNotes 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/Osdk.CancerPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListMdtNoteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/{primaryKey}/links/mdtNotes/{linkedObjectPrimaryKey}: get: tags: - CancerPathwayApiService operationId: cancerPathwayGetCancerPathwayLinkedMdtNotes 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/Osdk.CancerPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CancerPathway.MdtNote" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/{primaryKey}/links/patient: get: tags: - CancerPathwayApiService operationId: cancerPathwayListCancerPathwayLinkedPatient 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/Osdk.CancerPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerPathway/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - CancerPathwayApiService operationId: cancerPathwayGetCancerPathwayLinkedPatient 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/Osdk.CancerPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CancerPathway.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTrackingComment: get: tags: - CancerTrackingCommentApiService operationId: cancerTrackingCommentListCancerTrackingComment 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/Osdk.CancerTrackingCommentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCancerTrackingCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTrackingComment/aggregate: post: tags: - CancerTrackingCommentApiService operationId: cancerTrackingCommentComputeCancerTrackingCommentAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTrackingComment/count: post: tags: - CancerTrackingCommentApiService operationId: cancerTrackingCommentComputeCancerTrackingCommentCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTrackingComment/search: post: tags: - CancerTrackingCommentApiService operationId: cancerTrackingCommentSearchCancerTrackingComment parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchCancerTrackingCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTrackingComment/{primaryKey}: get: tags: - CancerTrackingCommentApiService operationId: cancerTrackingCommentGetCancerTrackingComment parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.CancerTrackingCommentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.CancerTrackingComment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTrackingComment/{primaryKey}/links/cancerPathway: get: tags: - CancerTrackingCommentApiService operationId: cancerTrackingCommentListCancerTrackingCommentLinkedCancerPathway 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/Osdk.CancerTrackingCommentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCancerPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTrackingComment/{primaryKey}/links/cancerPathway/{linkedObjectPrimaryKey} : get: tags: - CancerTrackingCommentApiService operationId: cancerTrackingCommentGetCancerTrackingCommentLinkedCancerPathway 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/Osdk.CancerTrackingCommentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CancerTrackingComment.CancerPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTreatment: get: tags: - CancerTreatmentApiService operationId: cancerTreatmentListCancerTreatment 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/Osdk.CancerTreatmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCancerTreatmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTreatment/aggregate: post: tags: - CancerTreatmentApiService operationId: cancerTreatmentComputeCancerTreatmentAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTreatment/count: post: tags: - CancerTreatmentApiService operationId: cancerTreatmentComputeCancerTreatmentCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTreatment/search: post: tags: - CancerTreatmentApiService operationId: cancerTreatmentSearchCancerTreatment parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchCancerTreatmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTreatment/{primaryKey}: get: tags: - CancerTreatmentApiService operationId: cancerTreatmentGetCancerTreatment parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.CancerTreatmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.CancerTreatment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTreatment/{primaryKey}/links/patient: get: tags: - CancerTreatmentApiService operationId: cancerTreatmentListCancerTreatmentLinkedPatient 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/Osdk.CancerTreatmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CancerTreatment/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - CancerTreatmentApiService operationId: cancerTreatmentGetCancerTreatmentLinkedPatient 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/Osdk.CancerTreatmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CancerTreatment.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessional 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/aggregate: post: tags: - CareProfessionalApiService operationId: careProfessionalComputeCareProfessionalAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/count: post: tags: - CareProfessionalApiService operationId: careProfessionalComputeCareProfessionalCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/search: post: tags: - CareProfessionalApiService operationId: careProfessionalSearchCareProfessional parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}: get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessional parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/assignedCareProfessionals: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedAssignedCareProfessionals 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAssignedCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/assignedCareProfessionals/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedAssignedCareProfessionals 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.AssignedCareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/bookingRequest: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedBookingRequest 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBookingRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/bookingRequest/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedBookingRequest 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.BookingRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/bookingRequestPrimaryConsultant: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedBookingRequestPrimaryConsultant 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBookingRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/bookingRequestPrimaryConsultant/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedBookingRequestPrimaryConsultant 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.BookingRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/clinicSession: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedClinicSession 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/clinicSession/{linkedObjectPrimaryKey}: get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedClinicSession 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.ClinicSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/encounter: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedEncounter 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}: get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedEncounter 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.Encounter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/outpatientActivities: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedOutpatientActivities 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListOutpatientActivityResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/outpatientActivities/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedOutpatientActivities 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.OutpatientActivity" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/patientPathway: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedPatientPathway 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/patientPathway/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedPatientPathway 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.PatientPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/pregnancies: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedPregnancies 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPregnancyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/pregnancies/{linkedObjectPrimaryKey}: get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedPregnancies 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.Pregnancy" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/procedures: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedProcedures 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/procedures/{linkedObjectPrimaryKey}: get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedProcedures 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.Procedure" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/proceduresAsPrimary: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedProceduresAsPrimary 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/proceduresAsPrimary/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedProceduresAsPrimary 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.Procedure" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/staffUnavailability: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedStaffUnavailability 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListStaffUnavailabilityResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/staffUnavailability/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedStaffUnavailability 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.StaffUnavailability" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/theatreBooking: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedTheatreBooking 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreBookingResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/theatreBooking/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedTheatreBooking 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.TheatreBooking" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/theatreSessionAllAnaesthetists: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedTheatreSessionAllAnaesthetists 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/theatreSessionAllAnaesthetists/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedTheatreSessionAllAnaesthetists 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.TheatreSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/theatreSessionAnaesthetist: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedTheatreSessionAnaesthetist 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/theatreSessionAnaesthetist/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedTheatreSessionAnaesthetist 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.TheatreSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/theatreSessionsAllConsultants: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedTheatreSessionsAllConsultants 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/theatreSessionsAllConsultants/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedTheatreSessionsAllConsultants 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.TheatreSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/theatreSessionsConsultant: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedTheatreSessionsConsultant 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/theatreSessionsConsultant/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedTheatreSessionsConsultant 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.TheatreSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/userPreference: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedUserPreference 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUserPreferenceResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/userPreference/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedUserPreference 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.UserPreference" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/validatedChangelog: get: tags: - CareProfessionalApiService operationId: careProfessionalListCareProfessionalLinkedValidatedChangelog 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/Osdk.CareProfessionalProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListValidatedChangelogResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareProfessional/{primaryKey}/links/validatedChangelog/{linkedObjectPrimaryKey} : get: tags: - CareProfessionalApiService operationId: careProfessionalGetCareProfessionalLinkedValidatedChangelog 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/Osdk.CareProfessionalProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareProfessional.ValidatedChangelog" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareService: get: tags: - CareServiceApiService operationId: careServiceListCareService 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/Osdk.CareServiceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareServiceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareService/aggregate: post: tags: - CareServiceApiService operationId: careServiceComputeCareServiceAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareService/count: post: tags: - CareServiceApiService operationId: careServiceComputeCareServiceCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/CareService/search: post: tags: - CareServiceApiService operationId: careServiceSearchCareService parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchCareServiceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareService/{primaryKey}: get: tags: - CareServiceApiService operationId: careServiceGetCareService parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.CareServiceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.CareService" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareService/{primaryKey}/links/incomingTransferOfCareRequests: get: tags: - CareServiceApiService operationId: careServiceListCareServiceLinkedIncomingTransferOfCareRequests 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/Osdk.CareServiceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTransferOfCareRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareService/{primaryKey}/links/incomingTransferOfCareRequests/{linkedObjectPrimaryKey} : get: tags: - CareServiceApiService operationId: careServiceGetCareServiceLinkedIncomingTransferOfCareRequests 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/Osdk.CareServiceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareService.TransferOfCareRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareService/{primaryKey}/links/outgoingTransferOfCareRequests: get: tags: - CareServiceApiService operationId: careServiceListCareServiceLinkedOutgoingTransferOfCareRequests 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/Osdk.CareServiceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTransferOfCareRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CareService/{primaryKey}/links/outgoingTransferOfCareRequests/{linkedObjectPrimaryKey} : get: tags: - CareServiceApiService operationId: careServiceGetCareServiceLinkedOutgoingTransferOfCareRequests 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/Osdk.CareServiceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareService.TransferOfCareRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareService/{primaryKey}/links/team: get: tags: - CareServiceApiService operationId: careServiceListCareServiceLinkedTeam 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/Osdk.CareServiceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmTeamResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CareService/{primaryKey}/links/team/{linkedObjectPrimaryKey}: get: tags: - CareServiceApiService operationId: careServiceGetCareServiceLinkedTeam 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/Osdk.CareServiceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CareService.CdmTeam" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmModulePermissioning: get: tags: - CdmModulePermissioningApiService operationId: cdmModulePermissioningListCdmModulePermissioning 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/Osdk.CdmModulePermissioningProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmModulePermissioningResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmModulePermissioning/aggregate: post: tags: - CdmModulePermissioningApiService operationId: cdmModulePermissioningComputeCdmModulePermissioningAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmModulePermissioning/count: post: tags: - CdmModulePermissioningApiService operationId: cdmModulePermissioningComputeCdmModulePermissioningCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/CdmModulePermissioning/search: post: tags: - CdmModulePermissioningApiService operationId: cdmModulePermissioningSearchCdmModulePermissioning parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchCdmModulePermissioningResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmModulePermissioning/{primaryKey}: get: tags: - CdmModulePermissioningApiService operationId: cdmModulePermissioningGetCdmModulePermissioning parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.CdmModulePermissioningProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.CdmModulePermissioning" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmModulePermissioning/{primaryKey}/links/logLogEditCdmModulePermissioning: get: tags: - CdmModulePermissioningApiService operationId: cdmModulePermissioningListCdmModulePermissioningLinkedLogLogEditCdmModulePermissioning 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/Osdk.CdmModulePermissioningProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListLogEditCdmModulePermissioningResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CdmModulePermissioning/{primaryKey}/links/logLogEditCdmModulePermissioning/{linkedObjectPrimaryKey} : get: tags: - CdmModulePermissioningApiService operationId: cdmModulePermissioningGetCdmModulePermissioningLinkedLogLogEditCdmModulePermissioning 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/Osdk.CdmModulePermissioningProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CdmModulePermissioning.LogEditCdmModulePermissioning" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmObjectPermissioning: get: tags: - CdmObjectPermissioningApiService operationId: cdmObjectPermissioningListCdmObjectPermissioning 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/Osdk.CdmObjectPermissioningProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmObjectPermissioningResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmObjectPermissioning/aggregate: post: tags: - CdmObjectPermissioningApiService operationId: cdmObjectPermissioningComputeCdmObjectPermissioningAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmObjectPermissioning/count: post: tags: - CdmObjectPermissioningApiService operationId: cdmObjectPermissioningComputeCdmObjectPermissioningCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/CdmObjectPermissioning/search: post: tags: - CdmObjectPermissioningApiService operationId: cdmObjectPermissioningSearchCdmObjectPermissioning parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchCdmObjectPermissioningResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmObjectPermissioning/{primaryKey}: get: tags: - CdmObjectPermissioningApiService operationId: cdmObjectPermissioningGetCdmObjectPermissioning parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.CdmObjectPermissioningProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.CdmObjectPermissioning" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CdmObjectPermissioning/{primaryKey}/links/logLogUpdateOptionalGroupIdsForObjectPermissioning : get: tags: - CdmObjectPermissioningApiService operationId: cdmObjectPermissioningListCdmObjectPermissioningLinkedLogLogUpdateOptionalGroupIdsForObjectPermissioning 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/Osdk.CdmObjectPermissioningProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListLogUpdateOptionalGroupIdsForObjectPermissioningResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CdmObjectPermissioning/{primaryKey}/links/logLogUpdateOptionalGroupIdsForObjectPermissioning/{linkedObjectPrimaryKey} : get: tags: - CdmObjectPermissioningApiService operationId: cdmObjectPermissioningGetCdmObjectPermissioningLinkedLogLogUpdateOptionalGroupIdsForObjectPermissioning 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/Osdk.CdmObjectPermissioningProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CdmObjectPermissioning.LogUpdateOptionalGroupIdsForObjectPermissioning" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmPathwayComment: get: tags: - CdmPathwayCommentApiService operationId: cdmPathwayCommentListCdmPathwayComment 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/Osdk.CdmPathwayCommentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmPathwayCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmPathwayComment/aggregate: post: tags: - CdmPathwayCommentApiService operationId: cdmPathwayCommentComputeCdmPathwayCommentAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmPathwayComment/count: post: tags: - CdmPathwayCommentApiService operationId: cdmPathwayCommentComputeCdmPathwayCommentCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/CdmPathwayComment/search: post: tags: - CdmPathwayCommentApiService operationId: cdmPathwayCommentSearchCdmPathwayComment parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchCdmPathwayCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmPathwayComment/{primaryKey}: get: tags: - CdmPathwayCommentApiService operationId: cdmPathwayCommentGetCdmPathwayComment parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.CdmPathwayCommentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.CdmPathwayComment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmPathwayComment/{primaryKey}/links/cdmPatientPathway: get: tags: - CdmPathwayCommentApiService operationId: cdmPathwayCommentListCdmPathwayCommentLinkedCdmPatientPathway 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/Osdk.CdmPathwayCommentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CdmPathwayComment/{primaryKey}/links/cdmPatientPathway/{linkedObjectPrimaryKey} : get: tags: - CdmPathwayCommentApiService operationId: cdmPathwayCommentGetCdmPathwayCommentLinkedCdmPatientPathway 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/Osdk.CdmPathwayCommentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CdmPathwayComment.PatientPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam: get: tags: - CdmTeamApiService operationId: cdmTeamListCdmTeam 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/Osdk.CdmTeamProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmTeamResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/aggregate: post: tags: - CdmTeamApiService operationId: cdmTeamComputeCdmTeamAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/count: post: tags: - CdmTeamApiService operationId: cdmTeamComputeCdmTeamCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/search: post: tags: - CdmTeamApiService operationId: cdmTeamSearchCdmTeam parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchCdmTeamResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/{primaryKey}: get: tags: - CdmTeamApiService operationId: cdmTeamGetCdmTeam parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.CdmTeamProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.CdmTeam" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/{primaryKey}/links/careService: get: tags: - CdmTeamApiService operationId: cdmTeamListCdmTeamLinkedCareService 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/Osdk.CdmTeamProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareServiceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/{primaryKey}/links/careService/{linkedObjectPrimaryKey}: get: tags: - CdmTeamApiService operationId: cdmTeamGetCdmTeamLinkedCareService 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/Osdk.CdmTeamProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CdmTeam.CareService" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/{primaryKey}/links/fdpLocalTeamMemberships: get: tags: - CdmTeamApiService operationId: cdmTeamListCdmTeamLinkedFdpLocalTeamMemberships 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/Osdk.CdmTeamProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmTeamMembershipResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/{primaryKey}/links/fdpLocalTeamMemberships/{linkedObjectPrimaryKey} : get: tags: - CdmTeamApiService operationId: cdmTeamGetCdmTeamLinkedFdpLocalTeamMemberships 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/Osdk.CdmTeamProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CdmTeam.CdmTeamMembership" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/{primaryKey}/links/shoSite: get: tags: - CdmTeamApiService operationId: cdmTeamListCdmTeamLinkedShoSite 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/Osdk.CdmTeamProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSiteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/{primaryKey}/links/shoSite/{linkedObjectPrimaryKey}: get: tags: - CdmTeamApiService operationId: cdmTeamGetCdmTeamLinkedShoSite 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/Osdk.CdmTeamProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CdmTeam.Site" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/{primaryKey}/links/shoSpecialty: get: tags: - CdmTeamApiService operationId: cdmTeamListCdmTeamLinkedShoSpecialty 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/Osdk.CdmTeamProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSpecialtyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/{primaryKey}/links/shoSpecialty/{linkedObjectPrimaryKey}: get: tags: - CdmTeamApiService operationId: cdmTeamGetCdmTeamLinkedShoSpecialty 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/Osdk.CdmTeamProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CdmTeam.Specialty" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/{primaryKey}/links/teamMembers: get: tags: - CdmTeamApiService operationId: cdmTeamListCdmTeamLinkedTeamMembers 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/Osdk.CdmTeamProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmTeamMemberResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeam/{primaryKey}/links/teamMembers/{linkedObjectPrimaryKey}: get: tags: - CdmTeamApiService operationId: cdmTeamGetCdmTeamLinkedTeamMembers 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/Osdk.CdmTeamProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CdmTeam.CdmTeamMember" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMember: get: tags: - CdmTeamMemberApiService operationId: cdmTeamMemberListCdmTeamMember 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/Osdk.CdmTeamMemberProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmTeamMemberResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMember/aggregate: post: tags: - CdmTeamMemberApiService operationId: cdmTeamMemberComputeCdmTeamMemberAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMember/count: post: tags: - CdmTeamMemberApiService operationId: cdmTeamMemberComputeCdmTeamMemberCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMember/search: post: tags: - CdmTeamMemberApiService operationId: cdmTeamMemberSearchCdmTeamMember parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchCdmTeamMemberResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMember/{primaryKey}: get: tags: - CdmTeamMemberApiService operationId: cdmTeamMemberGetCdmTeamMember parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.CdmTeamMemberProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.CdmTeamMember" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMember/{primaryKey}/links/fdpLocalTeamMemberships: get: tags: - CdmTeamMemberApiService operationId: cdmTeamMemberListCdmTeamMemberLinkedFdpLocalTeamMemberships 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/Osdk.CdmTeamMemberProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmTeamMembershipResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMember/{primaryKey}/links/fdpLocalTeamMemberships/{linkedObjectPrimaryKey} : get: tags: - CdmTeamMemberApiService operationId: cdmTeamMemberGetCdmTeamMemberLinkedFdpLocalTeamMemberships 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/Osdk.CdmTeamMemberProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CdmTeamMember.CdmTeamMembership" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMember/{primaryKey}/links/teams: get: tags: - CdmTeamMemberApiService operationId: cdmTeamMemberListCdmTeamMemberLinkedTeams 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/Osdk.CdmTeamMemberProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmTeamResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMember/{primaryKey}/links/teams/{linkedObjectPrimaryKey}: get: tags: - CdmTeamMemberApiService operationId: cdmTeamMemberGetCdmTeamMemberLinkedTeams 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/Osdk.CdmTeamMemberProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CdmTeamMember.CdmTeam" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMembership: get: tags: - CdmTeamMembershipApiService operationId: cdmTeamMembershipListCdmTeamMembership 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/Osdk.CdmTeamMembershipProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmTeamMembershipResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMembership/aggregate: post: tags: - CdmTeamMembershipApiService operationId: cdmTeamMembershipComputeCdmTeamMembershipAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMembership/count: post: tags: - CdmTeamMembershipApiService operationId: cdmTeamMembershipComputeCdmTeamMembershipCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMembership/search: post: tags: - CdmTeamMembershipApiService operationId: cdmTeamMembershipSearchCdmTeamMembership parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchCdmTeamMembershipResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMembership/{primaryKey}: get: tags: - CdmTeamMembershipApiService operationId: cdmTeamMembershipGetCdmTeamMembership parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.CdmTeamMembershipProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.CdmTeamMembership" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMembership/{primaryKey}/links/fdpLocalTeam: get: tags: - CdmTeamMembershipApiService operationId: cdmTeamMembershipListCdmTeamMembershipLinkedFdpLocalTeam 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/Osdk.CdmTeamMembershipProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmTeamResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMembership/{primaryKey}/links/fdpLocalTeam/{linkedObjectPrimaryKey}: get: tags: - CdmTeamMembershipApiService operationId: cdmTeamMembershipGetCdmTeamMembershipLinkedFdpLocalTeam 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/Osdk.CdmTeamMembershipProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CdmTeamMembership.CdmTeam" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMembership/{primaryKey}/links/fdpLocalTeamMember: get: tags: - CdmTeamMembershipApiService operationId: cdmTeamMembershipListCdmTeamMembershipLinkedFdpLocalTeamMember 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/Osdk.CdmTeamMembershipProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmTeamMemberResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CdmTeamMembership/{primaryKey}/links/fdpLocalTeamMember/{linkedObjectPrimaryKey} : get: tags: - CdmTeamMembershipApiService operationId: cdmTeamMembershipGetCdmTeamMembershipLinkedFdpLocalTeamMember 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/Osdk.CdmTeamMembershipProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CdmTeamMembership.CdmTeamMember" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ChangeLogRequest: get: tags: - ChangeLogRequestApiService operationId: changeLogRequestListChangeLogRequest 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/Osdk.ChangeLogRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListChangeLogRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ChangeLogRequest/aggregate: post: tags: - ChangeLogRequestApiService operationId: changeLogRequestComputeChangeLogRequestAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ChangeLogRequest/count: post: tags: - ChangeLogRequestApiService operationId: changeLogRequestComputeChangeLogRequestCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/ChangeLogRequest/search: post: tags: - ChangeLogRequestApiService operationId: changeLogRequestSearchChangeLogRequest parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchChangeLogRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ChangeLogRequest/{primaryKey}: get: tags: - ChangeLogRequestApiService operationId: changeLogRequestGetChangeLogRequest parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ChangeLogRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ChangeLogRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ChangeLogRequest/{primaryKey}/links/encounter: get: tags: - ChangeLogRequestApiService operationId: changeLogRequestListChangeLogRequestLinkedEncounter 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/Osdk.ChangeLogRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ChangeLogRequest/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}: get: tags: - ChangeLogRequestApiService operationId: changeLogRequestGetChangeLogRequestLinkedEncounter 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/Osdk.ChangeLogRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ChangeLogRequest.Encounter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ChangeLogRequest/{primaryKey}/links/validatedChangelogs: get: tags: - ChangeLogRequestApiService operationId: changeLogRequestListChangeLogRequestLinkedValidatedChangelogs 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/Osdk.ChangeLogRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListValidatedChangelogResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/ChangeLogRequest/{primaryKey}/links/validatedChangelogs/{linkedObjectPrimaryKey} : get: tags: - ChangeLogRequestApiService operationId: changeLogRequestGetChangeLogRequestLinkedValidatedChangelogs 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/Osdk.ChangeLogRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ChangeLogRequest.ValidatedChangelog" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicLetter: get: tags: - ClinicLetterApiService operationId: clinicLetterListClinicLetter 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/Osdk.ClinicLetterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicLetterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicLetter/aggregate: post: tags: - ClinicLetterApiService operationId: clinicLetterComputeClinicLetterAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicLetter/count: post: tags: - ClinicLetterApiService operationId: clinicLetterComputeClinicLetterCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicLetter/search: post: tags: - ClinicLetterApiService operationId: clinicLetterSearchClinicLetter parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchClinicLetterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicLetter/{primaryKey}: get: tags: - ClinicLetterApiService operationId: clinicLetterGetClinicLetter parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ClinicLetterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ClinicLetter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicLetter/{primaryKey}/links/appointment: get: tags: - ClinicLetterApiService operationId: clinicLetterListClinicLetterLinkedAppointment 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/Osdk.ClinicLetterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAppointmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicLetter/{primaryKey}/links/appointment/{linkedObjectPrimaryKey}: get: tags: - ClinicLetterApiService operationId: clinicLetterGetClinicLetterLinkedAppointment 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/Osdk.ClinicLetterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ClinicLetter.Appointment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicLetter/{primaryKey}/links/patient: get: tags: - ClinicLetterApiService operationId: clinicLetterListClinicLetterLinkedPatient 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/Osdk.ClinicLetterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicLetter/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - ClinicLetterApiService operationId: clinicLetterGetClinicLetterLinkedPatient 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/Osdk.ClinicLetterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ClinicLetter.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSession: get: tags: - ClinicSessionApiService operationId: clinicSessionListClinicSession 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/Osdk.ClinicSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSession/aggregate: post: tags: - ClinicSessionApiService operationId: clinicSessionComputeClinicSessionAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSession/count: post: tags: - ClinicSessionApiService operationId: clinicSessionComputeClinicSessionCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSession/search: post: tags: - ClinicSessionApiService operationId: clinicSessionSearchClinicSession parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchClinicSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSession/{primaryKey}: get: tags: - ClinicSessionApiService operationId: clinicSessionGetClinicSession parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ClinicSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ClinicSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSession/{primaryKey}/links/appointment: get: tags: - ClinicSessionApiService operationId: clinicSessionListClinicSessionLinkedAppointment 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/Osdk.ClinicSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAppointmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSession/{primaryKey}/links/appointment/{linkedObjectPrimaryKey}: get: tags: - ClinicSessionApiService operationId: clinicSessionGetClinicSessionLinkedAppointment 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/Osdk.ClinicSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ClinicSession.Appointment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSession/{primaryKey}/links/careProfessional: get: tags: - ClinicSessionApiService operationId: clinicSessionListClinicSessionLinkedCareProfessional 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/Osdk.ClinicSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSession/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey}: get: tags: - ClinicSessionApiService operationId: clinicSessionGetClinicSessionLinkedCareProfessional 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/Osdk.ClinicSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ClinicSession.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSession/{primaryKey}/links/clinicSlot: get: tags: - ClinicSessionApiService operationId: clinicSessionListClinicSessionLinkedClinicSlot 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/Osdk.ClinicSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicSlotResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSession/{primaryKey}/links/clinicSlot/{linkedObjectPrimaryKey}: get: tags: - ClinicSessionApiService operationId: clinicSessionGetClinicSessionLinkedClinicSlot 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/Osdk.ClinicSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ClinicSession.ClinicSlot" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSession/{primaryKey}/links/clinicType: get: tags: - ClinicSessionApiService operationId: clinicSessionListClinicSessionLinkedClinicType 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/Osdk.ClinicSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicTypeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSession/{primaryKey}/links/clinicType/{linkedObjectPrimaryKey}: get: tags: - ClinicSessionApiService operationId: clinicSessionGetClinicSessionLinkedClinicType 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/Osdk.ClinicSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ClinicSession.ClinicType" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSlot: get: tags: - ClinicSlotApiService operationId: clinicSlotListClinicSlot 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/Osdk.ClinicSlotProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicSlotResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSlot/aggregate: post: tags: - ClinicSlotApiService operationId: clinicSlotComputeClinicSlotAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSlot/count: post: tags: - ClinicSlotApiService operationId: clinicSlotComputeClinicSlotCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSlot/search: post: tags: - ClinicSlotApiService operationId: clinicSlotSearchClinicSlot parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchClinicSlotResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSlot/{primaryKey}: get: tags: - ClinicSlotApiService operationId: clinicSlotGetClinicSlot parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ClinicSlotProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ClinicSlot" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSlot/{primaryKey}/links/clinicSession: get: tags: - ClinicSlotApiService operationId: clinicSlotListClinicSlotLinkedClinicSession 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/Osdk.ClinicSlotProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSlot/{primaryKey}/links/clinicSession/{linkedObjectPrimaryKey}: get: tags: - ClinicSlotApiService operationId: clinicSlotGetClinicSlotLinkedClinicSession 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/Osdk.ClinicSlotProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ClinicSlot.ClinicSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSlot/{primaryKey}/links/ersService: get: tags: - ClinicSlotApiService operationId: clinicSlotListClinicSlotLinkedErsService 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/Osdk.ClinicSlotProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListErsServiceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicSlot/{primaryKey}/links/ersService/{linkedObjectPrimaryKey}: get: tags: - ClinicSlotApiService operationId: clinicSlotGetClinicSlotLinkedErsService 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/Osdk.ClinicSlotProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ClinicSlot.ErsService" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicType: get: tags: - ClinicTypeApiService operationId: clinicTypeListClinicType 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/Osdk.ClinicTypeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicTypeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicType/aggregate: post: tags: - ClinicTypeApiService operationId: clinicTypeComputeClinicTypeAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicType/count: post: tags: - ClinicTypeApiService operationId: clinicTypeComputeClinicTypeCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicType/search: post: tags: - ClinicTypeApiService operationId: clinicTypeSearchClinicType parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchClinicTypeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicType/{primaryKey}: get: tags: - ClinicTypeApiService operationId: clinicTypeGetClinicType parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ClinicTypeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ClinicType" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicType/{primaryKey}/links/clinicSession: get: tags: - ClinicTypeApiService operationId: clinicTypeListClinicTypeLinkedClinicSession 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/Osdk.ClinicTypeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicType/{primaryKey}/links/clinicSession/{linkedObjectPrimaryKey}: get: tags: - ClinicTypeApiService operationId: clinicTypeGetClinicTypeLinkedClinicSession 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/Osdk.ClinicTypeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ClinicType.ClinicSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicType/{primaryKey}/links/ersService: get: tags: - ClinicTypeApiService operationId: clinicTypeListClinicTypeLinkedErsService 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/Osdk.ClinicTypeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListErsServiceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicType/{primaryKey}/links/ersService/{linkedObjectPrimaryKey}: get: tags: - ClinicTypeApiService operationId: clinicTypeGetClinicTypeLinkedErsService 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/Osdk.ClinicTypeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ClinicType.ErsService" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicType/{primaryKey}/links/specialty: get: tags: - ClinicTypeApiService operationId: clinicTypeListClinicTypeLinkedSpecialty 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/Osdk.ClinicTypeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSpecialtyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ClinicType/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}: get: tags: - ClinicTypeApiService operationId: clinicTypeGetClinicTypeLinkedSpecialty 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/Osdk.ClinicTypeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ClinicType.Specialty" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Comorbidity: get: tags: - ComorbidityApiService operationId: comorbidityListComorbidity 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/Osdk.ComorbidityProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListComorbidityResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Comorbidity/aggregate: post: tags: - ComorbidityApiService operationId: comorbidityComputeComorbidityAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Comorbidity/count: post: tags: - ComorbidityApiService operationId: comorbidityComputeComorbidityCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Comorbidity/search: post: tags: - ComorbidityApiService operationId: comorbiditySearchComorbidity parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchComorbidityResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Comorbidity/{primaryKey}: get: tags: - ComorbidityApiService operationId: comorbidityGetComorbidity parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ComorbidityProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Comorbidity" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Comorbidity/{primaryKey}/links/patient: get: tags: - ComorbidityApiService operationId: comorbidityListComorbidityLinkedPatient 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/Osdk.ComorbidityProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Comorbidity/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - ComorbidityApiService operationId: comorbidityGetComorbidityLinkedPatient 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/Osdk.ComorbidityProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Comorbidity.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeListConsultantEpisode 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/Osdk.ConsultantEpisodeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListConsultantEpisodeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/aggregate: post: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeComputeConsultantEpisodeAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/count: post: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeComputeConsultantEpisodeCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/search: post: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeSearchConsultantEpisode parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchConsultantEpisodeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeGetConsultantEpisode parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ConsultantEpisodeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ConsultantEpisode" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/admission: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeListConsultantEpisodeLinkedAdmission 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/Osdk.ConsultantEpisodeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAdmissionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/admission/{linkedObjectPrimaryKey}: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeGetConsultantEpisodeLinkedAdmission 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/Osdk.ConsultantEpisodeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ConsultantEpisode.Admission" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/assignedCareProfessionals: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeListConsultantEpisodeLinkedAssignedCareProfessionals 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/Osdk.ConsultantEpisodeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAssignedCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/assignedCareProfessionals/{linkedObjectPrimaryKey} : get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeGetConsultantEpisodeLinkedAssignedCareProfessionals 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/Osdk.ConsultantEpisodeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ConsultantEpisode.AssignedCareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/homeLeaves: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeListConsultantEpisodeLinkedHomeLeaves 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/Osdk.ConsultantEpisodeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListHomeLeaveResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/homeLeaves/{linkedObjectPrimaryKey}: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeGetConsultantEpisodeLinkedHomeLeaves 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/Osdk.ConsultantEpisodeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ConsultantEpisode.HomeLeave" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/labour: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeListConsultantEpisodeLinkedLabour 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/Osdk.ConsultantEpisodeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListLabourResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/labour/{linkedObjectPrimaryKey}: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeGetConsultantEpisodeLinkedLabour 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/Osdk.ConsultantEpisodeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ConsultantEpisode.Labour" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/patient: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeListConsultantEpisodeLinkedPatient 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/Osdk.ConsultantEpisodeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeGetConsultantEpisodeLinkedPatient 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/Osdk.ConsultantEpisodeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ConsultantEpisode.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/patientDiagnoses: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeListConsultantEpisodeLinkedPatientDiagnoses 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/Osdk.ConsultantEpisodeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientDiagnosisResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/patientDiagnoses/{linkedObjectPrimaryKey} : get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeGetConsultantEpisodeLinkedPatientDiagnoses 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/Osdk.ConsultantEpisodeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ConsultantEpisode.PatientDiagnosis" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/procedures: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeListConsultantEpisodeLinkedProcedures 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/Osdk.ConsultantEpisodeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/procedures/{linkedObjectPrimaryKey}: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeGetConsultantEpisodeLinkedProcedures 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/Osdk.ConsultantEpisodeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ConsultantEpisode.Procedure" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/scoredAssessments: get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeListConsultantEpisodeLinkedScoredAssessments 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/Osdk.ConsultantEpisodeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListScoredAssessmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/ConsultantEpisode/{primaryKey}/links/scoredAssessments/{linkedObjectPrimaryKey} : get: tags: - ConsultantEpisodeApiService operationId: consultantEpisodeGetConsultantEpisodeLinkedScoredAssessments 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/Osdk.ConsultantEpisodeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ConsultantEpisode.ScoredAssessment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCareDailySummary: get: tags: - CriticalCareDailySummaryApiService operationId: criticalCareDailySummaryListCriticalCareDailySummary 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/Osdk.CriticalCareDailySummaryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCriticalCareDailySummaryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCareDailySummary/aggregate: post: tags: - CriticalCareDailySummaryApiService operationId: criticalCareDailySummaryComputeCriticalCareDailySummaryAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCareDailySummary/count: post: tags: - CriticalCareDailySummaryApiService operationId: criticalCareDailySummaryComputeCriticalCareDailySummaryCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCareDailySummary/search: post: tags: - CriticalCareDailySummaryApiService operationId: criticalCareDailySummarySearchCriticalCareDailySummary parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchCriticalCareDailySummaryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCareDailySummary/{primaryKey}: get: tags: - CriticalCareDailySummaryApiService operationId: criticalCareDailySummaryGetCriticalCareDailySummary parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.CriticalCareDailySummaryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.CriticalCareDailySummary" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCareDailySummary/{primaryKey}/links/criticalCarePeriod: get: tags: - CriticalCareDailySummaryApiService operationId: criticalCareDailySummaryListCriticalCareDailySummaryLinkedCriticalCarePeriod 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/Osdk.CriticalCareDailySummaryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCriticalCarePeriodResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCareDailySummary/{primaryKey}/links/criticalCarePeriod/{linkedObjectPrimaryKey} : get: tags: - CriticalCareDailySummaryApiService operationId: criticalCareDailySummaryGetCriticalCareDailySummaryLinkedCriticalCarePeriod 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/Osdk.CriticalCareDailySummaryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CriticalCareDailySummary.CriticalCarePeriod" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCarePeriod: get: tags: - CriticalCarePeriodApiService operationId: criticalCarePeriodListCriticalCarePeriod 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/Osdk.CriticalCarePeriodProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCriticalCarePeriodResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCarePeriod/aggregate: post: tags: - CriticalCarePeriodApiService operationId: criticalCarePeriodComputeCriticalCarePeriodAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCarePeriod/count: post: tags: - CriticalCarePeriodApiService operationId: criticalCarePeriodComputeCriticalCarePeriodCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCarePeriod/search: post: tags: - CriticalCarePeriodApiService operationId: criticalCarePeriodSearchCriticalCarePeriod parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchCriticalCarePeriodResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCarePeriod/{primaryKey}: get: tags: - CriticalCarePeriodApiService operationId: criticalCarePeriodGetCriticalCarePeriod parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.CriticalCarePeriodProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.CriticalCarePeriod" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCarePeriod/{primaryKey}/links/admission: get: tags: - CriticalCarePeriodApiService operationId: criticalCarePeriodListCriticalCarePeriodLinkedAdmission 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/Osdk.CriticalCarePeriodProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAdmissionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCarePeriod/{primaryKey}/links/admission/{linkedObjectPrimaryKey}: get: tags: - CriticalCarePeriodApiService operationId: criticalCarePeriodGetCriticalCarePeriodLinkedAdmission 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/Osdk.CriticalCarePeriodProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CriticalCarePeriod.Admission" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCarePeriod/{primaryKey}/links/criticalCareDailySummaries: get: tags: - CriticalCarePeriodApiService operationId: criticalCarePeriodListCriticalCarePeriodLinkedCriticalCareDailySummaries 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/Osdk.CriticalCarePeriodProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCriticalCareDailySummaryResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCarePeriod/{primaryKey}/links/criticalCareDailySummaries/{linkedObjectPrimaryKey} : get: tags: - CriticalCarePeriodApiService operationId: criticalCarePeriodGetCriticalCarePeriodLinkedCriticalCareDailySummaries 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/Osdk.CriticalCarePeriodProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CriticalCarePeriod.CriticalCareDailySummary" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCarePeriod/{primaryKey}/links/patient: get: tags: - CriticalCarePeriodApiService operationId: criticalCarePeriodListCriticalCarePeriodLinkedPatient 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/Osdk.CriticalCarePeriodProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/CriticalCarePeriod/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - CriticalCarePeriodApiService operationId: criticalCarePeriodGetCriticalCarePeriodLinkedPatient 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/Osdk.CriticalCarePeriodProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CriticalCarePeriod.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/DatasetRefreshTime: get: tags: - DatasetRefreshTimeApiService operationId: datasetRefreshTimeListDatasetRefreshTime 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/Osdk.DatasetRefreshTimeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListDatasetRefreshTimeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/DatasetRefreshTime/aggregate: post: tags: - DatasetRefreshTimeApiService operationId: datasetRefreshTimeComputeDatasetRefreshTimeAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/DatasetRefreshTime/count: post: tags: - DatasetRefreshTimeApiService operationId: datasetRefreshTimeComputeDatasetRefreshTimeCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/DatasetRefreshTime/search: post: tags: - DatasetRefreshTimeApiService operationId: datasetRefreshTimeSearchDatasetRefreshTime parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchDatasetRefreshTimeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/DatasetRefreshTime/{primaryKey}: get: tags: - DatasetRefreshTimeApiService operationId: datasetRefreshTimeGetDatasetRefreshTime parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.DatasetRefreshTimeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.DatasetRefreshTime" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/DiagnosticsWaitlistEntry: get: tags: - DiagnosticsWaitlistEntryApiService operationId: diagnosticsWaitlistEntryListDiagnosticsWaitlistEntry 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/Osdk.DiagnosticsWaitlistEntryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListDiagnosticsWaitlistEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/DiagnosticsWaitlistEntry/aggregate: post: tags: - DiagnosticsWaitlistEntryApiService operationId: diagnosticsWaitlistEntryComputeDiagnosticsWaitlistEntryAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/DiagnosticsWaitlistEntry/count: post: tags: - DiagnosticsWaitlistEntryApiService operationId: diagnosticsWaitlistEntryComputeDiagnosticsWaitlistEntryCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/DiagnosticsWaitlistEntry/search: post: tags: - DiagnosticsWaitlistEntryApiService operationId: diagnosticsWaitlistEntrySearchDiagnosticsWaitlistEntry parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchDiagnosticsWaitlistEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/DiagnosticsWaitlistEntry/{primaryKey}: get: tags: - DiagnosticsWaitlistEntryApiService operationId: diagnosticsWaitlistEntryGetDiagnosticsWaitlistEntry parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.DiagnosticsWaitlistEntryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.DiagnosticsWaitlistEntry" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/DiagnosticsWaitlistEntry/{primaryKey}/links/patient: get: tags: - DiagnosticsWaitlistEntryApiService operationId: diagnosticsWaitlistEntryListDiagnosticsWaitlistEntryLinkedPatient 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/Osdk.DiagnosticsWaitlistEntryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/DiagnosticsWaitlistEntry/{primaryKey}/links/patient/{linkedObjectPrimaryKey} : get: tags: - DiagnosticsWaitlistEntryApiService operationId: diagnosticsWaitlistEntryGetDiagnosticsWaitlistEntryLinkedPatient 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/Osdk.DiagnosticsWaitlistEntryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/DiagnosticsWaitlistEntry.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/DiagnosticsWaitlistEntry/{primaryKey}/links/patientPathway: get: tags: - DiagnosticsWaitlistEntryApiService operationId: diagnosticsWaitlistEntryListDiagnosticsWaitlistEntryLinkedPatientPathway 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/Osdk.DiagnosticsWaitlistEntryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/DiagnosticsWaitlistEntry/{primaryKey}/links/patientPathway/{linkedObjectPrimaryKey} : get: tags: - DiagnosticsWaitlistEntryApiService operationId: diagnosticsWaitlistEntryGetDiagnosticsWaitlistEntryLinkedPatientPathway 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/Osdk.DiagnosticsWaitlistEntryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/DiagnosticsWaitlistEntry.PatientPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/DiagnosticsWaitlistEntry/{primaryKey}/links/specialty: get: tags: - DiagnosticsWaitlistEntryApiService operationId: diagnosticsWaitlistEntryListDiagnosticsWaitlistEntryLinkedSpecialty 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/Osdk.DiagnosticsWaitlistEntryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSpecialtyResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/DiagnosticsWaitlistEntry/{primaryKey}/links/specialty/{linkedObjectPrimaryKey} : get: tags: - DiagnosticsWaitlistEntryApiService operationId: diagnosticsWaitlistEntryGetDiagnosticsWaitlistEntryLinkedSpecialty 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/Osdk.DiagnosticsWaitlistEntryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/DiagnosticsWaitlistEntry.Specialty" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EMed3FitNote: get: tags: - EMed3FitNoteApiService operationId: eMed3FitNoteListEMed3FitNote 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/Osdk.EMed3FitNoteProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEMed3FitNoteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EMed3FitNote/aggregate: post: tags: - EMed3FitNoteApiService operationId: eMed3FitNoteComputeEMed3FitNoteAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EMed3FitNote/count: post: tags: - EMed3FitNoteApiService operationId: eMed3FitNoteComputeEMed3FitNoteCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/EMed3FitNote/search: post: tags: - EMed3FitNoteApiService operationId: eMed3FitNoteSearchEMed3FitNote parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchEMed3FitNoteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EMed3FitNote/{primaryKey}: get: tags: - EMed3FitNoteApiService operationId: eMed3FitNoteGetEMed3FitNote parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.EMed3FitNoteProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.EMed3FitNote" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EMed3FitNote/{primaryKey}/links/admission: get: tags: - EMed3FitNoteApiService operationId: eMed3FitNoteListEMed3FitNoteLinkedAdmission 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/Osdk.EMed3FitNoteProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAdmissionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EMed3FitNote/{primaryKey}/links/admission/{linkedObjectPrimaryKey}: get: tags: - EMed3FitNoteApiService operationId: eMed3FitNoteGetEMed3FitNoteLinkedAdmission 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/Osdk.EMed3FitNoteProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/EMed3FitNote.Admission" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EMed3FitNote/{primaryKey}/links/appointment: get: tags: - EMed3FitNoteApiService operationId: eMed3FitNoteListEMed3FitNoteLinkedAppointment 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/Osdk.EMed3FitNoteProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAppointmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EMed3FitNote/{primaryKey}/links/appointment/{linkedObjectPrimaryKey}: get: tags: - EMed3FitNoteApiService operationId: eMed3FitNoteGetEMed3FitNoteLinkedAppointment 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/Osdk.EMed3FitNoteProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/EMed3FitNote.Appointment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EMed3FitNote/{primaryKey}/links/patient: get: tags: - EMed3FitNoteApiService operationId: eMed3FitNoteListEMed3FitNoteLinkedPatient 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/Osdk.EMed3FitNoteProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EMed3FitNote/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - EMed3FitNoteApiService operationId: eMed3FitNoteGetEMed3FitNoteLinkedPatient 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/Osdk.EMed3FitNoteProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/EMed3FitNote.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EMed3FitNote/{primaryKey}/links/uecAttendance: get: tags: - EMed3FitNoteApiService operationId: eMed3FitNoteListEMed3FitNoteLinkedUecAttendance 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/Osdk.EMed3FitNoteProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUecAttendanceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EMed3FitNote/{primaryKey}/links/uecAttendance/{linkedObjectPrimaryKey}: get: tags: - EMed3FitNoteApiService operationId: eMed3FitNoteGetEMed3FitNoteLinkedUecAttendance 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/Osdk.EMed3FitNoteProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/EMed3FitNote.UecAttendance" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EalEntry: get: tags: - EalEntryApiService operationId: ealEntryListEalEntry 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/Osdk.EalEntryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEalEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EalEntry/aggregate: post: tags: - EalEntryApiService operationId: ealEntryComputeEalEntryAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EalEntry/count: post: tags: - EalEntryApiService operationId: ealEntryComputeEalEntryCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/EalEntry/search: post: tags: - EalEntryApiService operationId: ealEntrySearchEalEntry parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchEalEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EalEntry/{primaryKey}: get: tags: - EalEntryApiService operationId: ealEntryGetEalEntry parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.EalEntryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.EalEntry" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EalEntry/{primaryKey}/links/encounter: get: tags: - EalEntryApiService operationId: ealEntryListEalEntryLinkedEncounter 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/Osdk.EalEntryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EalEntry/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}: get: tags: - EalEntryApiService operationId: ealEntryGetEalEntryLinkedEncounter 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/Osdk.EalEntryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/EalEntry.Encounter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EalEntry/{primaryKey}/links/patient: get: tags: - EalEntryApiService operationId: ealEntryListEalEntryLinkedPatient 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/Osdk.EalEntryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EalEntry/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - EalEntryApiService operationId: ealEntryGetEalEntryLinkedPatient 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/Osdk.EalEntryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/EalEntry.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EalEntry/{primaryKey}/links/theatreBooking: get: tags: - EalEntryApiService operationId: ealEntryListEalEntryLinkedTheatreBooking 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/Osdk.EalEntryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreBookingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/EalEntry/{primaryKey}/links/theatreBooking/{linkedObjectPrimaryKey}: get: tags: - EalEntryApiService operationId: ealEntryGetEalEntryLinkedTheatreBooking 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/Osdk.EalEntryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/EalEntry.TheatreBooking" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter: get: tags: - EncounterApiService operationId: encounterListEncounter 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/Osdk.EncounterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/aggregate: post: tags: - EncounterApiService operationId: encounterComputeEncounterAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/count: post: tags: - EncounterApiService operationId: encounterComputeEncounterCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/search: post: tags: - EncounterApiService operationId: encounterSearchEncounter parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}: get: tags: - EncounterApiService operationId: encounterGetEncounter parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.EncounterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Encounter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/bookingRequest: get: tags: - EncounterApiService operationId: encounterListEncounterLinkedBookingRequest 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/Osdk.EncounterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBookingRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/bookingRequest/{linkedObjectPrimaryKey}: get: tags: - EncounterApiService operationId: encounterGetEncounterLinkedBookingRequest 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/Osdk.EncounterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Encounter.BookingRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/careProfessional: get: tags: - EncounterApiService operationId: encounterListEncounterLinkedCareProfessional 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/Osdk.EncounterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey}: get: tags: - EncounterApiService operationId: encounterGetEncounterLinkedCareProfessional 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/Osdk.EncounterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Encounter.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/changeLogRequest: get: tags: - EncounterApiService operationId: encounterListEncounterLinkedChangeLogRequest 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/Osdk.EncounterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListChangeLogRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/changeLogRequest/{linkedObjectPrimaryKey}: get: tags: - EncounterApiService operationId: encounterGetEncounterLinkedChangeLogRequest 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/Osdk.EncounterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Encounter.ChangeLogRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/ealEntry: get: tags: - EncounterApiService operationId: encounterListEncounterLinkedEalEntry 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/Osdk.EncounterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEalEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/ealEntry/{linkedObjectPrimaryKey}: get: tags: - EncounterApiService operationId: encounterGetEncounterLinkedEalEntry 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/Osdk.EncounterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Encounter.EalEntry" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/patient: get: tags: - EncounterApiService operationId: encounterListEncounterLinkedPatient 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/Osdk.EncounterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - EncounterApiService operationId: encounterGetEncounterLinkedPatient 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/Osdk.EncounterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Encounter.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/patientPathway: get: tags: - EncounterApiService operationId: encounterListEncounterLinkedPatientPathway 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/Osdk.EncounterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/patientPathway/{linkedObjectPrimaryKey}: get: tags: - EncounterApiService operationId: encounterGetEncounterLinkedPatientPathway 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/Osdk.EncounterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Encounter.PatientPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/procedure: get: tags: - EncounterApiService operationId: encounterListEncounterLinkedProcedure 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/Osdk.EncounterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/procedure/{linkedObjectPrimaryKey}: get: tags: - EncounterApiService operationId: encounterGetEncounterLinkedProcedure 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/Osdk.EncounterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Encounter.Procedure" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/procedureStatus: get: tags: - EncounterApiService operationId: encounterListEncounterLinkedProcedureStatus 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/Osdk.EncounterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureStatusResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/procedureStatus/{linkedObjectPrimaryKey}: get: tags: - EncounterApiService operationId: encounterGetEncounterLinkedProcedureStatus 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/Osdk.EncounterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Encounter.ProcedureStatus" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/specialty: get: tags: - EncounterApiService operationId: encounterListEncounterLinkedSpecialty 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/Osdk.EncounterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSpecialtyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}: get: tags: - EncounterApiService operationId: encounterGetEncounterLinkedSpecialty 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/Osdk.EncounterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Encounter.Specialty" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/theatreBooking: get: tags: - EncounterApiService operationId: encounterListEncounterLinkedTheatreBooking 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/Osdk.EncounterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreBookingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/theatreBooking/{linkedObjectPrimaryKey}: get: tags: - EncounterApiService operationId: encounterGetEncounterLinkedTheatreBooking 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/Osdk.EncounterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Encounter.TheatreBooking" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/validatedChangelog: get: tags: - EncounterApiService operationId: encounterListEncounterLinkedValidatedChangelog 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/Osdk.EncounterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListValidatedChangelogResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/validatedChangelog/{linkedObjectPrimaryKey}: get: tags: - EncounterApiService operationId: encounterGetEncounterLinkedValidatedChangelog 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/Osdk.EncounterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Encounter.ValidatedChangelog" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/waitlistEntry: get: tags: - EncounterApiService operationId: encounterListEncounterLinkedWaitlistEntry 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/Osdk.EncounterProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListWaitlistEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Encounter/{primaryKey}/links/waitlistEntry/{linkedObjectPrimaryKey}: get: tags: - EncounterApiService operationId: encounterGetEncounterLinkedWaitlistEntry 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/Osdk.EncounterProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Encounter.WaitlistEntry" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Endoscopy: get: tags: - EndoscopyApiService operationId: endoscopyListEndoscopy 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/Osdk.EndoscopyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEndoscopyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Endoscopy/aggregate: post: tags: - EndoscopyApiService operationId: endoscopyComputeEndoscopyAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Endoscopy/count: post: tags: - EndoscopyApiService operationId: endoscopyComputeEndoscopyCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Endoscopy/search: post: tags: - EndoscopyApiService operationId: endoscopySearchEndoscopy parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchEndoscopyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Endoscopy/{primaryKey}: get: tags: - EndoscopyApiService operationId: endoscopyGetEndoscopy parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.EndoscopyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Endoscopy" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Endoscopy/{primaryKey}/links/patient: get: tags: - EndoscopyApiService operationId: endoscopyListEndoscopyLinkedPatient 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/Osdk.EndoscopyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Endoscopy/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - EndoscopyApiService operationId: endoscopyGetEndoscopyLinkedPatient 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/Osdk.EndoscopyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Endoscopy.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService: get: tags: - ErsServiceApiService operationId: ersServiceListErsService 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/Osdk.ErsServiceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListErsServiceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/aggregate: post: tags: - ErsServiceApiService operationId: ersServiceComputeErsServiceAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/count: post: tags: - ErsServiceApiService operationId: ersServiceComputeErsServiceCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/search: post: tags: - ErsServiceApiService operationId: ersServiceSearchErsService parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchErsServiceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/{primaryKey}: get: tags: - ErsServiceApiService operationId: ersServiceGetErsService parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ErsServiceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ErsService" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/{primaryKey}/links/clinicSlot: get: tags: - ErsServiceApiService operationId: ersServiceListErsServiceLinkedClinicSlot 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/Osdk.ErsServiceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicSlotResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/{primaryKey}/links/clinicSlot/{linkedObjectPrimaryKey}: get: tags: - ErsServiceApiService operationId: ersServiceGetErsServiceLinkedClinicSlot 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/Osdk.ErsServiceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ErsService.ClinicSlot" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/{primaryKey}/links/clinicType: get: tags: - ErsServiceApiService operationId: ersServiceListErsServiceLinkedClinicType 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/Osdk.ErsServiceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicTypeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/{primaryKey}/links/clinicType/{linkedObjectPrimaryKey}: get: tags: - ErsServiceApiService operationId: ersServiceGetErsServiceLinkedClinicType 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/Osdk.ErsServiceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ErsService.ClinicType" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/{primaryKey}/links/referral: get: tags: - ErsServiceApiService operationId: ersServiceListErsServiceLinkedReferral 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/Osdk.ErsServiceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListReferralResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/{primaryKey}/links/referral/{linkedObjectPrimaryKey}: get: tags: - ErsServiceApiService operationId: ersServiceGetErsServiceLinkedReferral 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/Osdk.ErsServiceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ErsService.Referral" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/{primaryKey}/links/site: get: tags: - ErsServiceApiService operationId: ersServiceListErsServiceLinkedSite 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/Osdk.ErsServiceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSiteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/{primaryKey}/links/site/{linkedObjectPrimaryKey}: get: tags: - ErsServiceApiService operationId: ersServiceGetErsServiceLinkedSite 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/Osdk.ErsServiceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ErsService.Site" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/{primaryKey}/links/specialty: get: tags: - ErsServiceApiService operationId: ersServiceListErsServiceLinkedSpecialty 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/Osdk.ErsServiceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSpecialtyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ErsService/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}: get: tags: - ErsServiceApiService operationId: ersServiceGetErsServiceLinkedSpecialty 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/Osdk.ErsServiceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ErsService.Specialty" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Finding: get: tags: - FindingApiService operationId: findingListFinding 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/Osdk.FindingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListFindingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Finding/aggregate: post: tags: - FindingApiService operationId: findingComputeFindingAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Finding/count: post: tags: - FindingApiService operationId: findingComputeFindingCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Finding/search: post: tags: - FindingApiService operationId: findingSearchFinding parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchFindingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Finding/{primaryKey}: get: tags: - FindingApiService operationId: findingGetFinding parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.FindingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Finding" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Finding/{primaryKey}/links/virtualWardStay: get: tags: - FindingApiService operationId: findingListFindingLinkedVirtualWardStay 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/Osdk.FindingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListVirtualWardStayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Finding/{primaryKey}/links/virtualWardStay/{linkedObjectPrimaryKey}: get: tags: - FindingApiService operationId: findingGetFindingLinkedVirtualWardStay 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/Osdk.FindingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Finding.VirtualWardStay" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/GpPracticeRegistration: get: tags: - GpPracticeRegistrationApiService operationId: gpPracticeRegistrationListGpPracticeRegistration 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/Osdk.GpPracticeRegistrationProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListGpPracticeRegistrationResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/GpPracticeRegistration/aggregate: post: tags: - GpPracticeRegistrationApiService operationId: gpPracticeRegistrationComputeGpPracticeRegistrationAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/GpPracticeRegistration/count: post: tags: - GpPracticeRegistrationApiService operationId: gpPracticeRegistrationComputeGpPracticeRegistrationCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/GpPracticeRegistration/search: post: tags: - GpPracticeRegistrationApiService operationId: gpPracticeRegistrationSearchGpPracticeRegistration parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchGpPracticeRegistrationResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/GpPracticeRegistration/{primaryKey}: get: tags: - GpPracticeRegistrationApiService operationId: gpPracticeRegistrationGetGpPracticeRegistration parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.GpPracticeRegistrationProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.GpPracticeRegistration" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/GpPracticeRegistration/{primaryKey}/links/patient: get: tags: - GpPracticeRegistrationApiService operationId: gpPracticeRegistrationListGpPracticeRegistrationLinkedPatient 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/Osdk.GpPracticeRegistrationProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/GpPracticeRegistration/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - GpPracticeRegistrationApiService operationId: gpPracticeRegistrationGetGpPracticeRegistrationLinkedPatient 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/Osdk.GpPracticeRegistrationProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/GpPracticeRegistration.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Histology: get: tags: - HistologyApiService operationId: histologyListHistology 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/Osdk.HistologyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListHistologyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Histology/aggregate: post: tags: - HistologyApiService operationId: histologyComputeHistologyAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Histology/count: post: tags: - HistologyApiService operationId: histologyComputeHistologyCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Histology/search: post: tags: - HistologyApiService operationId: histologySearchHistology parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchHistologyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Histology/{primaryKey}: get: tags: - HistologyApiService operationId: histologyGetHistology parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.HistologyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Histology" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Histology/{primaryKey}/links/patient: get: tags: - HistologyApiService operationId: histologyListHistologyLinkedPatient 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/Osdk.HistologyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Histology/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - HistologyApiService operationId: histologyGetHistologyLinkedPatient 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/Osdk.HistologyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Histology.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/HomeLeave: get: tags: - HomeLeaveApiService operationId: homeLeaveListHomeLeave 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/Osdk.HomeLeaveProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListHomeLeaveResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/HomeLeave/aggregate: post: tags: - HomeLeaveApiService operationId: homeLeaveComputeHomeLeaveAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/HomeLeave/count: post: tags: - HomeLeaveApiService operationId: homeLeaveComputeHomeLeaveCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/HomeLeave/search: post: tags: - HomeLeaveApiService operationId: homeLeaveSearchHomeLeave parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchHomeLeaveResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/HomeLeave/{primaryKey}: get: tags: - HomeLeaveApiService operationId: homeLeaveGetHomeLeave parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.HomeLeaveProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.HomeLeave" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/HomeLeave/{primaryKey}/links/admission: get: tags: - HomeLeaveApiService operationId: homeLeaveListHomeLeaveLinkedAdmission 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/Osdk.HomeLeaveProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAdmissionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/HomeLeave/{primaryKey}/links/admission/{linkedObjectPrimaryKey}: get: tags: - HomeLeaveApiService operationId: homeLeaveGetHomeLeaveLinkedAdmission 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/Osdk.HomeLeaveProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/HomeLeave.Admission" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/HomeLeave/{primaryKey}/links/consultantEpisode: get: tags: - HomeLeaveApiService operationId: homeLeaveListHomeLeaveLinkedConsultantEpisode 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/Osdk.HomeLeaveProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListConsultantEpisodeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/HomeLeave/{primaryKey}/links/consultantEpisode/{linkedObjectPrimaryKey}: get: tags: - HomeLeaveApiService operationId: homeLeaveGetHomeLeaveLinkedConsultantEpisode 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/Osdk.HomeLeaveProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/HomeLeave.ConsultantEpisode" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/HomeLeave/{primaryKey}/links/patient: get: tags: - HomeLeaveApiService operationId: homeLeaveListHomeLeaveLinkedPatient 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/Osdk.HomeLeaveProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/HomeLeave/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - HomeLeaveApiService operationId: homeLeaveGetHomeLeaveLinkedPatient 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/Osdk.HomeLeaveProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/HomeLeave.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Injury: get: tags: - InjuryApiService operationId: injuryListInjury 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/Osdk.InjuryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListInjuryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Injury/aggregate: post: tags: - InjuryApiService operationId: injuryComputeInjuryAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Injury/count: post: tags: - InjuryApiService operationId: injuryComputeInjuryCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Injury/search: post: tags: - InjuryApiService operationId: injurySearchInjury parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchInjuryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Injury/{primaryKey}: get: tags: - InjuryApiService operationId: injuryGetInjury parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.InjuryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Injury" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Injury/{primaryKey}/links/patient: get: tags: - InjuryApiService operationId: injuryListInjuryLinkedPatient 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/Osdk.InjuryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Injury/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - InjuryApiService operationId: injuryGetInjuryLinkedPatient 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/Osdk.InjuryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Injury.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Injury/{primaryKey}/links/uecAttendance: get: tags: - InjuryApiService operationId: injuryListInjuryLinkedUecAttendance 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/Osdk.InjuryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUecAttendanceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Injury/{primaryKey}/links/uecAttendance/{linkedObjectPrimaryKey}: get: tags: - InjuryApiService operationId: injuryGetInjuryLinkedUecAttendance 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/Osdk.InjuryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Injury.UecAttendance" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/InterProviderTransfer: get: tags: - InterProviderTransferApiService operationId: interProviderTransferListInterProviderTransfer 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/Osdk.InterProviderTransferProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListInterProviderTransferResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/InterProviderTransfer/aggregate: post: tags: - InterProviderTransferApiService operationId: interProviderTransferComputeInterProviderTransferAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/InterProviderTransfer/count: post: tags: - InterProviderTransferApiService operationId: interProviderTransferComputeInterProviderTransferCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/InterProviderTransfer/search: post: tags: - InterProviderTransferApiService operationId: interProviderTransferSearchInterProviderTransfer parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchInterProviderTransferResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/InterProviderTransfer/{primaryKey}: get: tags: - InterProviderTransferApiService operationId: interProviderTransferGetInterProviderTransfer parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.InterProviderTransferProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.InterProviderTransfer" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/InterProviderTransfer/{primaryKey}/links/cancerPathway: get: tags: - InterProviderTransferApiService operationId: interProviderTransferListInterProviderTransferLinkedCancerPathway 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/Osdk.InterProviderTransferProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCancerPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/InterProviderTransfer/{primaryKey}/links/cancerPathway/{linkedObjectPrimaryKey} : get: tags: - InterProviderTransferApiService operationId: interProviderTransferGetInterProviderTransferLinkedCancerPathway 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/Osdk.InterProviderTransferProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/InterProviderTransfer.CancerPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/InterProviderTransfer/{primaryKey}/links/patient: get: tags: - InterProviderTransferApiService operationId: interProviderTransferListInterProviderTransferLinkedPatient 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/Osdk.InterProviderTransferProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/InterProviderTransfer/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - InterProviderTransferApiService operationId: interProviderTransferGetInterProviderTransferLinkedPatient 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/Osdk.InterProviderTransferProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/InterProviderTransfer.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Labour: get: tags: - LabourApiService operationId: labourListLabour 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/Osdk.LabourProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListLabourResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Labour/aggregate: post: tags: - LabourApiService operationId: labourComputeLabourAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Labour/count: post: tags: - LabourApiService operationId: labourComputeLabourCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Labour/search: post: tags: - LabourApiService operationId: labourSearchLabour parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchLabourResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Labour/{primaryKey}: get: tags: - LabourApiService operationId: labourGetLabour parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.LabourProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Labour" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Labour/{primaryKey}/links/admission: get: tags: - LabourApiService operationId: labourListLabourLinkedAdmission 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/Osdk.LabourProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAdmissionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Labour/{primaryKey}/links/admission/{linkedObjectPrimaryKey}: get: tags: - LabourApiService operationId: labourGetLabourLinkedAdmission 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/Osdk.LabourProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Labour.Admission" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Labour/{primaryKey}/links/births: get: tags: - LabourApiService operationId: labourListLabourLinkedBirths 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/Osdk.LabourProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBirthResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Labour/{primaryKey}/links/births/{linkedObjectPrimaryKey}: get: tags: - LabourApiService operationId: labourGetLabourLinkedBirths 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/Osdk.LabourProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Labour.Birth" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Labour/{primaryKey}/links/consultantEpisode: get: tags: - LabourApiService operationId: labourListLabourLinkedConsultantEpisode 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/Osdk.LabourProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListConsultantEpisodeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Labour/{primaryKey}/links/consultantEpisode/{linkedObjectPrimaryKey}: get: tags: - LabourApiService operationId: labourGetLabourLinkedConsultantEpisode 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/Osdk.LabourProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Labour.ConsultantEpisode" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Labour/{primaryKey}/links/pregnancy: get: tags: - LabourApiService operationId: labourListLabourLinkedPregnancy 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/Osdk.LabourProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPregnancyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Labour/{primaryKey}/links/pregnancy/{linkedObjectPrimaryKey}: get: tags: - LabourApiService operationId: labourGetLabourLinkedPregnancy 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/Osdk.LabourProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Labour.Pregnancy" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/LogEditCdmModulePermissioning: get: tags: - LogEditCdmModulePermissioningApiService operationId: logEditCdmModulePermissioningListLogEditCdmModulePermissioning 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/Osdk.LogEditCdmModulePermissioningProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListLogEditCdmModulePermissioningResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/LogEditCdmModulePermissioning/aggregate: post: tags: - LogEditCdmModulePermissioningApiService operationId: logEditCdmModulePermissioningComputeLogEditCdmModulePermissioningAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/LogEditCdmModulePermissioning/count: post: tags: - LogEditCdmModulePermissioningApiService operationId: logEditCdmModulePermissioningComputeLogEditCdmModulePermissioningCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/LogEditCdmModulePermissioning/search: post: tags: - LogEditCdmModulePermissioningApiService operationId: logEditCdmModulePermissioningSearchLogEditCdmModulePermissioning parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchLogEditCdmModulePermissioningResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/LogEditCdmModulePermissioning/{primaryKey}: get: tags: - LogEditCdmModulePermissioningApiService operationId: logEditCdmModulePermissioningGetLogEditCdmModulePermissioning parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.LogEditCdmModulePermissioningProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.LogEditCdmModulePermissioning" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/LogEditCdmModulePermissioning/{primaryKey}/links/editedCdmModulePermissioning : get: tags: - LogEditCdmModulePermissioningApiService operationId: logEditCdmModulePermissioningListLogEditCdmModulePermissioningLinkedEditedCdmModulePermissioning 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/Osdk.LogEditCdmModulePermissioningProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmModulePermissioningResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/LogEditCdmModulePermissioning/{primaryKey}/links/editedCdmModulePermissioning/{linkedObjectPrimaryKey} : get: tags: - LogEditCdmModulePermissioningApiService operationId: logEditCdmModulePermissioningGetLogEditCdmModulePermissioningLinkedEditedCdmModulePermissioning 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/Osdk.LogEditCdmModulePermissioningProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/LogEditCdmModulePermissioning.CdmModulePermissioning" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/LogUpdateOptionalGroupIdsForObjectPermissioning: get: tags: - LogUpdateOptionalGroupIdsForObjectPermissioningApiService operationId: logUpdateOptionalGroupIdsForObjectPermissioningListLogUpdateOptionalGroupIdsForObjectPermissioning 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/Osdk.LogUpdateOptionalGroupIdsForObjectPermissioningProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListLogUpdateOptionalGroupIdsForObjectPermissioningResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/LogUpdateOptionalGroupIdsForObjectPermissioning/aggregate: post: tags: - LogUpdateOptionalGroupIdsForObjectPermissioningApiService operationId: logUpdateOptionalGroupIdsForObjectPermissioningComputeLogUpdateOptionalGroupIdsForObjectPermissioningAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/LogUpdateOptionalGroupIdsForObjectPermissioning/count: post: tags: - LogUpdateOptionalGroupIdsForObjectPermissioningApiService operationId: logUpdateOptionalGroupIdsForObjectPermissioningComputeLogUpdateOptionalGroupIdsForObjectPermissioningCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/LogUpdateOptionalGroupIdsForObjectPermissioning/search: post: tags: - LogUpdateOptionalGroupIdsForObjectPermissioningApiService operationId: logUpdateOptionalGroupIdsForObjectPermissioningSearchLogUpdateOptionalGroupIdsForObjectPermissioning parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchLogUpdateOptionalGroupIdsForObjectPermissioningResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/LogUpdateOptionalGroupIdsForObjectPermissioning/{primaryKey}: get: tags: - LogUpdateOptionalGroupIdsForObjectPermissioningApiService operationId: logUpdateOptionalGroupIdsForObjectPermissioningGetLogUpdateOptionalGroupIdsForObjectPermissioning parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.LogUpdateOptionalGroupIdsForObjectPermissioningProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.LogUpdateOptionalGroupIdsForObjectPermissioning" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/LogUpdateOptionalGroupIdsForObjectPermissioning/{primaryKey}/links/editedCdmObjectPermissioning : get: tags: - LogUpdateOptionalGroupIdsForObjectPermissioningApiService operationId: logUpdateOptionalGroupIdsForObjectPermissioningListLogUpdateOptionalGroupIdsForObjectPermissioningLinkedEditedCdmObjectPermissioning 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/Osdk.LogUpdateOptionalGroupIdsForObjectPermissioningProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmObjectPermissioningResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/LogUpdateOptionalGroupIdsForObjectPermissioning/{primaryKey}/links/editedCdmObjectPermissioning/{linkedObjectPrimaryKey} : get: tags: - LogUpdateOptionalGroupIdsForObjectPermissioningApiService operationId: logUpdateOptionalGroupIdsForObjectPermissioningGetLogUpdateOptionalGroupIdsForObjectPermissioningLinkedEditedCdmObjectPermissioning 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/Osdk.LogUpdateOptionalGroupIdsForObjectPermissioningProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/LogUpdateOptionalGroupIdsForObjectPermissioning.CdmObjectPermissioning" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/MdtNote: get: tags: - MdtNoteApiService operationId: mdtNoteListMdtNote 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/Osdk.MdtNoteProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListMdtNoteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/MdtNote/aggregate: post: tags: - MdtNoteApiService operationId: mdtNoteComputeMdtNoteAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/MdtNote/count: post: tags: - MdtNoteApiService operationId: mdtNoteComputeMdtNoteCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/MdtNote/search: post: tags: - MdtNoteApiService operationId: mdtNoteSearchMdtNote parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchMdtNoteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/MdtNote/{primaryKey}: get: tags: - MdtNoteApiService operationId: mdtNoteGetMdtNote parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.MdtNoteProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.MdtNote" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/MdtNote/{primaryKey}/links/cancerPathway: get: tags: - MdtNoteApiService operationId: mdtNoteListMdtNoteLinkedCancerPathway 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/Osdk.MdtNoteProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCancerPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/MdtNote/{primaryKey}/links/cancerPathway/{linkedObjectPrimaryKey}: get: tags: - MdtNoteApiService operationId: mdtNoteGetMdtNoteLinkedCancerPathway 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/Osdk.MdtNoteProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/MdtNote.CancerPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/MdtNote/{primaryKey}/links/mdtMeeting: get: tags: - MdtNoteApiService operationId: mdtNoteListMdtNoteLinkedMdtMeeting 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/Osdk.MdtNoteProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListMdtMeetingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/MdtNote/{primaryKey}/links/mdtMeeting/{linkedObjectPrimaryKey}: get: tags: - MdtNoteApiService operationId: mdtNoteGetMdtNoteLinkedMdtMeeting 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/Osdk.MdtNoteProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/MdtNote.mdtMeeting" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/MentalHealthActLegalStatus: get: tags: - MentalHealthActLegalStatusApiService operationId: mentalHealthActLegalStatusListMentalHealthActLegalStatus 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/Osdk.MentalHealthActLegalStatusProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListMentalHealthActLegalStatusResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/MentalHealthActLegalStatus/aggregate: post: tags: - MentalHealthActLegalStatusApiService operationId: mentalHealthActLegalStatusComputeMentalHealthActLegalStatusAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/MentalHealthActLegalStatus/count: post: tags: - MentalHealthActLegalStatusApiService operationId: mentalHealthActLegalStatusComputeMentalHealthActLegalStatusCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/MentalHealthActLegalStatus/search: post: tags: - MentalHealthActLegalStatusApiService operationId: mentalHealthActLegalStatusSearchMentalHealthActLegalStatus parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchMentalHealthActLegalStatusResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/MentalHealthActLegalStatus/{primaryKey}: get: tags: - MentalHealthActLegalStatusApiService operationId: mentalHealthActLegalStatusGetMentalHealthActLegalStatus parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.MentalHealthActLegalStatusProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.MentalHealthActLegalStatus" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/MentalHealthActLegalStatus/{primaryKey}/links/patient: get: tags: - MentalHealthActLegalStatusApiService operationId: mentalHealthActLegalStatusListMentalHealthActLegalStatusLinkedPatient 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/Osdk.MentalHealthActLegalStatusProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/MentalHealthActLegalStatus/{primaryKey}/links/patient/{linkedObjectPrimaryKey} : get: tags: - MentalHealthActLegalStatusApiService operationId: mentalHealthActLegalStatusGetMentalHealthActLegalStatusLinkedPatient 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/Osdk.MentalHealthActLegalStatusProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/MentalHealthActLegalStatus.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Observation: get: tags: - ObservationApiService operationId: observationListObservation 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/Osdk.ObservationProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListObservationResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Observation/aggregate: post: tags: - ObservationApiService operationId: observationComputeObservationAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Observation/count: post: tags: - ObservationApiService operationId: observationComputeObservationCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Observation/search: post: tags: - ObservationApiService operationId: observationSearchObservation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchObservationResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Observation/{primaryKey}: get: tags: - ObservationApiService operationId: observationGetObservation parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ObservationProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Observation" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Observation/{primaryKey}/links/virtualWardStay: get: tags: - ObservationApiService operationId: observationListObservationLinkedVirtualWardStay 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/Osdk.ObservationProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListVirtualWardStayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Observation/{primaryKey}/links/virtualWardStay/{linkedObjectPrimaryKey}: get: tags: - ObservationApiService operationId: observationGetObservationLinkedVirtualWardStay 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/Osdk.ObservationProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Observation.VirtualWardStay" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity: get: tags: - OutpatientActivityApiService operationId: outpatientActivityListOutpatientActivity 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/Osdk.OutpatientActivityProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListOutpatientActivityResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/aggregate: post: tags: - OutpatientActivityApiService operationId: outpatientActivityComputeOutpatientActivityAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/count: post: tags: - OutpatientActivityApiService operationId: outpatientActivityComputeOutpatientActivityCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/search: post: tags: - OutpatientActivityApiService operationId: outpatientActivitySearchOutpatientActivity parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchOutpatientActivityResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/{primaryKey}: get: tags: - OutpatientActivityApiService operationId: outpatientActivityGetOutpatientActivity parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.OutpatientActivityProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.OutpatientActivity" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/{primaryKey}/links/careProfessional: get: tags: - OutpatientActivityApiService operationId: outpatientActivityListOutpatientActivityLinkedCareProfessional 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/Osdk.OutpatientActivityProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey} : get: tags: - OutpatientActivityApiService operationId: outpatientActivityGetOutpatientActivityLinkedCareProfessional 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/Osdk.OutpatientActivityProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/OutpatientActivity.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/{primaryKey}/links/patient: get: tags: - OutpatientActivityApiService operationId: outpatientActivityListOutpatientActivityLinkedPatient 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/Osdk.OutpatientActivityProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - OutpatientActivityApiService operationId: outpatientActivityGetOutpatientActivityLinkedPatient 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/Osdk.OutpatientActivityProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/OutpatientActivity.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/{primaryKey}/links/patientPathway: get: tags: - OutpatientActivityApiService operationId: outpatientActivityListOutpatientActivityLinkedPatientPathway 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/Osdk.OutpatientActivityProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/{primaryKey}/links/patientPathway/{linkedObjectPrimaryKey} : get: tags: - OutpatientActivityApiService operationId: outpatientActivityGetOutpatientActivityLinkedPatientPathway 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/Osdk.OutpatientActivityProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/OutpatientActivity.PatientPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/{primaryKey}/links/referral: get: tags: - OutpatientActivityApiService operationId: outpatientActivityListOutpatientActivityLinkedReferral 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/Osdk.OutpatientActivityProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListReferralResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/{primaryKey}/links/referral/{linkedObjectPrimaryKey}: get: tags: - OutpatientActivityApiService operationId: outpatientActivityGetOutpatientActivityLinkedReferral 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/Osdk.OutpatientActivityProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/OutpatientActivity.Referral" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/{primaryKey}/links/specialty: get: tags: - OutpatientActivityApiService operationId: outpatientActivityListOutpatientActivityLinkedSpecialty 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/Osdk.OutpatientActivityProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSpecialtyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}: get: tags: - OutpatientActivityApiService operationId: outpatientActivityGetOutpatientActivityLinkedSpecialty 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/Osdk.OutpatientActivityProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/OutpatientActivity.Specialty" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/{primaryKey}/links/waitlistEntry: get: tags: - OutpatientActivityApiService operationId: outpatientActivityListOutpatientActivityLinkedWaitlistEntry 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/Osdk.OutpatientActivityProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListWaitlistEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/OutpatientActivity/{primaryKey}/links/waitlistEntry/{linkedObjectPrimaryKey} : get: tags: - OutpatientActivityApiService operationId: outpatientActivityGetOutpatientActivityLinkedWaitlistEntry 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/Osdk.OutpatientActivityProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/OutpatientActivity.WaitlistEntry" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OverseasVisitorChargingCategoryPeriod: get: tags: - OverseasVisitorChargingCategoryPeriodApiService operationId: overseasVisitorChargingCategoryPeriodListOverseasVisitorChargingCategoryPeriod 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/Osdk.OverseasVisitorChargingCategoryPeriodProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListOverseasVisitorChargingCategoryPeriodResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OverseasVisitorChargingCategoryPeriod/aggregate: post: tags: - OverseasVisitorChargingCategoryPeriodApiService operationId: overseasVisitorChargingCategoryPeriodComputeOverseasVisitorChargingCategoryPeriodAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OverseasVisitorChargingCategoryPeriod/count: post: tags: - OverseasVisitorChargingCategoryPeriodApiService operationId: overseasVisitorChargingCategoryPeriodComputeOverseasVisitorChargingCategoryPeriodCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/OverseasVisitorChargingCategoryPeriod/search: post: tags: - OverseasVisitorChargingCategoryPeriodApiService operationId: overseasVisitorChargingCategoryPeriodSearchOverseasVisitorChargingCategoryPeriod parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchOverseasVisitorChargingCategoryPeriodResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OverseasVisitorChargingCategoryPeriod/{primaryKey}: get: tags: - OverseasVisitorChargingCategoryPeriodApiService operationId: overseasVisitorChargingCategoryPeriodGetOverseasVisitorChargingCategoryPeriod parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.OverseasVisitorChargingCategoryPeriodProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.OverseasVisitorChargingCategoryPeriod" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/OverseasVisitorChargingCategoryPeriod/{primaryKey}/links/patient: get: tags: - OverseasVisitorChargingCategoryPeriodApiService operationId: overseasVisitorChargingCategoryPeriodListOverseasVisitorChargingCategoryPeriodLinkedPatient 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/Osdk.OverseasVisitorChargingCategoryPeriodProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/OverseasVisitorChargingCategoryPeriod/{primaryKey}/links/patient/{linkedObjectPrimaryKey} : get: tags: - OverseasVisitorChargingCategoryPeriodApiService operationId: overseasVisitorChargingCategoryPeriodGetOverseasVisitorChargingCategoryPeriodLinkedPatient 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/Osdk.OverseasVisitorChargingCategoryPeriodProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/OverseasVisitorChargingCategoryPeriod.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient: get: tags: - PatientApiService operationId: patientListPatient 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/aggregate: post: tags: - PatientApiService operationId: patientComputePatientAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/count: post: tags: - PatientApiService operationId: patientComputePatientCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/search: post: tags: - PatientApiService operationId: patientSearchPatient parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}: get: tags: - PatientApiService operationId: patientGetPatient parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/admission: get: tags: - PatientApiService operationId: patientListPatientLinkedAdmission 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAdmissionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/admission/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedAdmission 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.Admission" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/appointment: get: tags: - PatientApiService operationId: patientListPatientLinkedAppointment 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAppointmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/appointment/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedAppointment 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.Appointment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/birth: get: tags: - PatientApiService operationId: patientListPatientLinkedBirth 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBirthResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/birth/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedBirth 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.Birth" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/bookingRequest: get: tags: - PatientApiService operationId: patientListPatientLinkedBookingRequest 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBookingRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/bookingRequest/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedBookingRequest 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.BookingRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/cancerPathways: get: tags: - PatientApiService operationId: patientListPatientLinkedCancerPathways 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCancerPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/cancerPathways/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedCancerPathways 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.CancerPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/cancerTreatments: get: tags: - PatientApiService operationId: patientListPatientLinkedCancerTreatments 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCancerTreatmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/cancerTreatments/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedCancerTreatments 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.CancerTreatment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/clinicLetter: get: tags: - PatientApiService operationId: patientListPatientLinkedClinicLetter 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicLetterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/clinicLetter/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedClinicLetter 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.ClinicLetter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/comorbidities: get: tags: - PatientApiService operationId: patientListPatientLinkedComorbidities 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListComorbidityResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/comorbidities/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedComorbidities 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.Comorbidity" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/consultantEpisodes: get: tags: - PatientApiService operationId: patientListPatientLinkedConsultantEpisodes 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListConsultantEpisodeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/consultantEpisodes/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedConsultantEpisodes 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.ConsultantEpisode" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/criticalCarePeriods: get: tags: - PatientApiService operationId: patientListPatientLinkedCriticalCarePeriods 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCriticalCarePeriodResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/criticalCarePeriods/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedCriticalCarePeriods 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.CriticalCarePeriod" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/diagnosticsWaitlistEntries: get: tags: - PatientApiService operationId: patientListPatientLinkedDiagnosticsWaitlistEntries 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListDiagnosticsWaitlistEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/diagnosticsWaitlistEntries/{linkedObjectPrimaryKey} : get: tags: - PatientApiService operationId: patientGetPatientLinkedDiagnosticsWaitlistEntries 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.DiagnosticsWaitlistEntry" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/ealEntry: get: tags: - PatientApiService operationId: patientListPatientLinkedEalEntry 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEalEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/ealEntry/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedEalEntry 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.EalEntry" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/emed3fitNotes: get: tags: - PatientApiService operationId: patientListPatientLinkedEmed3fitNotes 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEMed3FitNoteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/emed3fitNotes/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedEmed3fitNotes 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.EMed3FitNote" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/encounter: get: tags: - PatientApiService operationId: patientListPatientLinkedEncounter 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedEncounter 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.Encounter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/endoscopies: get: tags: - PatientApiService operationId: patientListPatientLinkedEndoscopies 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEndoscopyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/endoscopies/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedEndoscopies 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.Endoscopy" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/gpPracticeRegistrations: get: tags: - PatientApiService operationId: patientListPatientLinkedGpPracticeRegistrations 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListGpPracticeRegistrationResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/gpPracticeRegistrations/{linkedObjectPrimaryKey} : get: tags: - PatientApiService operationId: patientGetPatientLinkedGpPracticeRegistrations 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.GpPracticeRegistration" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/histologies: get: tags: - PatientApiService operationId: patientListPatientLinkedHistologies 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListHistologyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/histologies/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedHistologies 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.Histology" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/homeLeaves: get: tags: - PatientApiService operationId: patientListPatientLinkedHomeLeaves 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListHomeLeaveResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/homeLeaves/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedHomeLeaves 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.HomeLeave" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/injuries: get: tags: - PatientApiService operationId: patientListPatientLinkedInjuries 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListInjuryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/injuries/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedInjuries 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.Injury" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/interProviderTransfers: get: tags: - PatientApiService operationId: patientListPatientLinkedInterProviderTransfers 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListInterProviderTransferResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/interProviderTransfers/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedInterProviderTransfers 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.InterProviderTransfer" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/mentalHealthActLegalStatuses: get: tags: - PatientApiService operationId: patientListPatientLinkedMentalHealthActLegalStatuses 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListMentalHealthActLegalStatusResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/mentalHealthActLegalStatuses/{linkedObjectPrimaryKey} : get: tags: - PatientApiService operationId: patientGetPatientLinkedMentalHealthActLegalStatuses 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.MentalHealthActLegalStatus" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/outpatientActivity: get: tags: - PatientApiService operationId: patientListPatientLinkedOutpatientActivity 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListOutpatientActivityResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/outpatientActivity/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedOutpatientActivity 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.OutpatientActivity" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/overseasVisitorChargingCategoryPeriods: get: tags: - PatientApiService operationId: patientListPatientLinkedOverseasVisitorChargingCategoryPeriods 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListOverseasVisitorChargingCategoryPeriodResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/overseasVisitorChargingCategoryPeriods/{linkedObjectPrimaryKey} : get: tags: - PatientApiService operationId: patientGetPatientLinkedOverseasVisitorChargingCategoryPeriods 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.OverseasVisitorChargingCategoryPeriod" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/patientAddressHistories: get: tags: - PatientApiService operationId: patientListPatientLinkedPatientAddressHistories 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientAddressHistoryResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/patientAddressHistories/{linkedObjectPrimaryKey} : get: tags: - PatientApiService operationId: patientGetPatientLinkedPatientAddressHistories 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.PatientAddressHistory" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/patientDiagnosis: get: tags: - PatientApiService operationId: patientListPatientLinkedPatientDiagnosis 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientDiagnosisResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/patientDiagnosis/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedPatientDiagnosis 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.PatientDiagnosis" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/patientPathway: get: tags: - PatientApiService operationId: patientListPatientLinkedPatientPathway 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/patientPathway/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedPatientPathway 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.PatientPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/pregnancies: get: tags: - PatientApiService operationId: patientListPatientLinkedPregnancies 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPregnancyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/pregnancies/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedPregnancies 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.Pregnancy" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/procedure: get: tags: - PatientApiService operationId: patientListPatientLinkedProcedure 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/procedure/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedProcedure 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.Procedure" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/procedureStatus: get: tags: - PatientApiService operationId: patientListPatientLinkedProcedureStatus 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureStatusResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/procedureStatus/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedProcedureStatus 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.ProcedureStatus" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/radiologyExams: get: tags: - PatientApiService operationId: patientListPatientLinkedRadiologyExams 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListRadiologyExamResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/radiologyExams/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedRadiologyExams 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.RadiologyExam" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/referral: get: tags: - PatientApiService operationId: patientListPatientLinkedReferral 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListReferralResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/referral/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedReferral 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.Referral" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/scoredAssessments: get: tags: - PatientApiService operationId: patientListPatientLinkedScoredAssessments 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListScoredAssessmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/scoredAssessments/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedScoredAssessments 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.ScoredAssessment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/testResult: get: tags: - PatientApiService operationId: patientListPatientLinkedTestResult 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTestResultResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/testResult/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedTestResult 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.TestResult" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/theatreBooking: get: tags: - PatientApiService operationId: patientListPatientLinkedTheatreBooking 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreBookingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/theatreBooking/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedTheatreBooking 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.TheatreBooking" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/uecAttendances: get: tags: - PatientApiService operationId: patientListPatientLinkedUecAttendances 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUecAttendanceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/uecAttendances/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedUecAttendances 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.UecAttendance" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/uecReferrals: get: tags: - PatientApiService operationId: patientListPatientLinkedUecReferrals 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUecReferralResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/uecReferrals/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedUecReferrals 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.UecReferral" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/wardStays: get: tags: - PatientApiService operationId: patientListPatientLinkedWardStays 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/Osdk.PatientProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListWardStayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Patient/{primaryKey}/links/wardStays/{linkedObjectPrimaryKey}: get: tags: - PatientApiService operationId: patientGetPatientLinkedWardStays 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/Osdk.PatientProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Patient.WardStay" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientAddressHistory: get: tags: - PatientAddressHistoryApiService operationId: patientAddressHistoryListPatientAddressHistory 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/Osdk.PatientAddressHistoryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientAddressHistoryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientAddressHistory/aggregate: post: tags: - PatientAddressHistoryApiService operationId: patientAddressHistoryComputePatientAddressHistoryAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientAddressHistory/count: post: tags: - PatientAddressHistoryApiService operationId: patientAddressHistoryComputePatientAddressHistoryCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/PatientAddressHistory/search: post: tags: - PatientAddressHistoryApiService operationId: patientAddressHistorySearchPatientAddressHistory parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchPatientAddressHistoryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientAddressHistory/{primaryKey}: get: tags: - PatientAddressHistoryApiService operationId: patientAddressHistoryGetPatientAddressHistory parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.PatientAddressHistoryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.PatientAddressHistory" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientAddressHistory/{primaryKey}/links/patient: get: tags: - PatientAddressHistoryApiService operationId: patientAddressHistoryListPatientAddressHistoryLinkedPatient 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/Osdk.PatientAddressHistoryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientAddressHistory/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - PatientAddressHistoryApiService operationId: patientAddressHistoryGetPatientAddressHistoryLinkedPatient 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/Osdk.PatientAddressHistoryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientAddressHistory.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientDiagnosis: get: tags: - PatientDiagnosisApiService operationId: patientDiagnosisListPatientDiagnosis 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/Osdk.PatientDiagnosisProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientDiagnosisResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientDiagnosis/aggregate: post: tags: - PatientDiagnosisApiService operationId: patientDiagnosisComputePatientDiagnosisAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientDiagnosis/count: post: tags: - PatientDiagnosisApiService operationId: patientDiagnosisComputePatientDiagnosisCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/PatientDiagnosis/search: post: tags: - PatientDiagnosisApiService operationId: patientDiagnosisSearchPatientDiagnosis parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchPatientDiagnosisResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientDiagnosis/{primaryKey}: get: tags: - PatientDiagnosisApiService operationId: patientDiagnosisGetPatientDiagnosis parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.PatientDiagnosisProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.PatientDiagnosis" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientDiagnosis/{primaryKey}/links/consultantEpisode: get: tags: - PatientDiagnosisApiService operationId: patientDiagnosisListPatientDiagnosisLinkedConsultantEpisode 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/Osdk.PatientDiagnosisProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListConsultantEpisodeResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/PatientDiagnosis/{primaryKey}/links/consultantEpisode/{linkedObjectPrimaryKey} : get: tags: - PatientDiagnosisApiService operationId: patientDiagnosisGetPatientDiagnosisLinkedConsultantEpisode 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/Osdk.PatientDiagnosisProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientDiagnosis.ConsultantEpisode" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientDiagnosis/{primaryKey}/links/patient: get: tags: - PatientDiagnosisApiService operationId: patientDiagnosisListPatientDiagnosisLinkedPatient 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/Osdk.PatientDiagnosisProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientDiagnosis/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - PatientDiagnosisApiService operationId: patientDiagnosisGetPatientDiagnosisLinkedPatient 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/Osdk.PatientDiagnosisProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientDiagnosis.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientDiagnosis/{primaryKey}/links/uecAttendance: get: tags: - PatientDiagnosisApiService operationId: patientDiagnosisListPatientDiagnosisLinkedUecAttendance 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/Osdk.PatientDiagnosisProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUecAttendanceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientDiagnosis/{primaryKey}/links/uecAttendance/{linkedObjectPrimaryKey}: get: tags: - PatientDiagnosisApiService operationId: patientDiagnosisGetPatientDiagnosisLinkedUecAttendance 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/Osdk.PatientDiagnosisProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientDiagnosis.UecAttendance" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientDiagnosis/{primaryKey}/links/virtualWardStay: get: tags: - PatientDiagnosisApiService operationId: patientDiagnosisListPatientDiagnosisLinkedVirtualWardStay 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/Osdk.PatientDiagnosisProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListVirtualWardStayResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/PatientDiagnosis/{primaryKey}/links/virtualWardStay/{linkedObjectPrimaryKey} : get: tags: - PatientDiagnosisApiService operationId: patientDiagnosisGetPatientDiagnosisLinkedVirtualWardStay 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/Osdk.PatientDiagnosisProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientDiagnosis.VirtualWardStay" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway: get: tags: - PatientPathwayApiService operationId: patientPathwayListPatientPathway 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/Osdk.PatientPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/aggregate: post: tags: - PatientPathwayApiService operationId: patientPathwayComputePatientPathwayAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/count: post: tags: - PatientPathwayApiService operationId: patientPathwayComputePatientPathwayCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/search: post: tags: - PatientPathwayApiService operationId: patientPathwaySearchPatientPathway parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchPatientPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}: get: tags: - PatientPathwayApiService operationId: patientPathwayGetPatientPathway parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.PatientPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.PatientPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/careProfessional: get: tags: - PatientPathwayApiService operationId: patientPathwayListPatientPathwayLinkedCareProfessional 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/Osdk.PatientPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey} : get: tags: - PatientPathwayApiService operationId: patientPathwayGetPatientPathwayLinkedCareProfessional 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/Osdk.PatientPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientPathway.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/cdmPathwayComments: get: tags: - PatientPathwayApiService operationId: patientPathwayListPatientPathwayLinkedCdmPathwayComments 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/Osdk.PatientPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmPathwayCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/cdmPathwayComments/{linkedObjectPrimaryKey} : get: tags: - PatientPathwayApiService operationId: patientPathwayGetPatientPathwayLinkedCdmPathwayComments 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/Osdk.PatientPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientPathway.CdmPathwayComment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/diagnosticsWaitlistEntries: get: tags: - PatientPathwayApiService operationId: patientPathwayListPatientPathwayLinkedDiagnosticsWaitlistEntries 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/Osdk.PatientPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListDiagnosticsWaitlistEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/diagnosticsWaitlistEntries/{linkedObjectPrimaryKey} : get: tags: - PatientPathwayApiService operationId: patientPathwayGetPatientPathwayLinkedDiagnosticsWaitlistEntries 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/Osdk.PatientPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientPathway.DiagnosticsWaitlistEntry" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/encounter: get: tags: - PatientPathwayApiService operationId: patientPathwayListPatientPathwayLinkedEncounter 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/Osdk.PatientPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}: get: tags: - PatientPathwayApiService operationId: patientPathwayGetPatientPathwayLinkedEncounter 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/Osdk.PatientPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientPathway.Encounter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/outpatientActivity: get: tags: - PatientPathwayApiService operationId: patientPathwayListPatientPathwayLinkedOutpatientActivity 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/Osdk.PatientPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListOutpatientActivityResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/outpatientActivity/{linkedObjectPrimaryKey} : get: tags: - PatientPathwayApiService operationId: patientPathwayGetPatientPathwayLinkedOutpatientActivity 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/Osdk.PatientPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientPathway.OutpatientActivity" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/patient: get: tags: - PatientPathwayApiService operationId: patientPathwayListPatientPathwayLinkedPatient 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/Osdk.PatientPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - PatientPathwayApiService operationId: patientPathwayGetPatientPathwayLinkedPatient 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/Osdk.PatientPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientPathway.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/referral: get: tags: - PatientPathwayApiService operationId: patientPathwayListPatientPathwayLinkedReferral 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/Osdk.PatientPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListReferralResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/referral/{linkedObjectPrimaryKey}: get: tags: - PatientPathwayApiService operationId: patientPathwayGetPatientPathwayLinkedReferral 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/Osdk.PatientPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientPathway.Referral" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/site: get: tags: - PatientPathwayApiService operationId: patientPathwayListPatientPathwayLinkedSite 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/Osdk.PatientPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSiteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/site/{linkedObjectPrimaryKey}: get: tags: - PatientPathwayApiService operationId: patientPathwayGetPatientPathwayLinkedSite 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/Osdk.PatientPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientPathway.Site" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/specialty: get: tags: - PatientPathwayApiService operationId: patientPathwayListPatientPathwayLinkedSpecialty 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/Osdk.PatientPathwayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSpecialtyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/PatientPathway/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}: get: tags: - PatientPathwayApiService operationId: patientPathwayGetPatientPathwayLinkedSpecialty 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/Osdk.PatientPathwayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PatientPathway.Specialty" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Pregnancy: get: tags: - PregnancyApiService operationId: pregnancyListPregnancy 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/Osdk.PregnancyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPregnancyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Pregnancy/aggregate: post: tags: - PregnancyApiService operationId: pregnancyComputePregnancyAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Pregnancy/count: post: tags: - PregnancyApiService operationId: pregnancyComputePregnancyCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Pregnancy/search: post: tags: - PregnancyApiService operationId: pregnancySearchPregnancy parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchPregnancyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Pregnancy/{primaryKey}: get: tags: - PregnancyApiService operationId: pregnancyGetPregnancy parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.PregnancyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Pregnancy" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Pregnancy/{primaryKey}/links/births: get: tags: - PregnancyApiService operationId: pregnancyListPregnancyLinkedBirths 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/Osdk.PregnancyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBirthResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Pregnancy/{primaryKey}/links/births/{linkedObjectPrimaryKey}: get: tags: - PregnancyApiService operationId: pregnancyGetPregnancyLinkedBirths 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/Osdk.PregnancyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Pregnancy.Birth" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Pregnancy/{primaryKey}/links/careProfessional: get: tags: - PregnancyApiService operationId: pregnancyListPregnancyLinkedCareProfessional 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/Osdk.PregnancyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Pregnancy/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey}: get: tags: - PregnancyApiService operationId: pregnancyGetPregnancyLinkedCareProfessional 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/Osdk.PregnancyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Pregnancy.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Pregnancy/{primaryKey}/links/labours: get: tags: - PregnancyApiService operationId: pregnancyListPregnancyLinkedLabours 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/Osdk.PregnancyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListLabourResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Pregnancy/{primaryKey}/links/labours/{linkedObjectPrimaryKey}: get: tags: - PregnancyApiService operationId: pregnancyGetPregnancyLinkedLabours 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/Osdk.PregnancyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Pregnancy.Labour" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Pregnancy/{primaryKey}/links/patient: get: tags: - PregnancyApiService operationId: pregnancyListPregnancyLinkedPatient 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/Osdk.PregnancyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Pregnancy/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - PregnancyApiService operationId: pregnancyGetPregnancyLinkedPatient 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/Osdk.PregnancyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Pregnancy.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure: get: tags: - ProcedureApiService operationId: procedureListProcedure 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/Osdk.ProcedureProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/aggregate: post: tags: - ProcedureApiService operationId: procedureComputeProcedureAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/count: post: tags: - ProcedureApiService operationId: procedureComputeProcedureCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/search: post: tags: - ProcedureApiService operationId: procedureSearchProcedure parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchProcedureResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}: get: tags: - ProcedureApiService operationId: procedureGetProcedure parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ProcedureProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Procedure" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/careProfessionalPrimary: get: tags: - ProcedureApiService operationId: procedureListProcedureLinkedCareProfessionalPrimary 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/Osdk.ProcedureProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/careProfessionalPrimary/{linkedObjectPrimaryKey} : get: tags: - ProcedureApiService operationId: procedureGetProcedureLinkedCareProfessionalPrimary 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/Osdk.ProcedureProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Procedure.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/careProfessionals: get: tags: - ProcedureApiService operationId: procedureListProcedureLinkedCareProfessionals 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/Osdk.ProcedureProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/careProfessionals/{linkedObjectPrimaryKey}: get: tags: - ProcedureApiService operationId: procedureGetProcedureLinkedCareProfessionals 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/Osdk.ProcedureProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Procedure.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/consultantEpisode: get: tags: - ProcedureApiService operationId: procedureListProcedureLinkedConsultantEpisode 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/Osdk.ProcedureProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListConsultantEpisodeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/consultantEpisode/{linkedObjectPrimaryKey}: get: tags: - ProcedureApiService operationId: procedureGetProcedureLinkedConsultantEpisode 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/Osdk.ProcedureProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Procedure.ConsultantEpisode" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/encounter: get: tags: - ProcedureApiService operationId: procedureListProcedureLinkedEncounter 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/Osdk.ProcedureProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}: get: tags: - ProcedureApiService operationId: procedureGetProcedureLinkedEncounter 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/Osdk.ProcedureProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Procedure.Encounter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/patient: get: tags: - ProcedureApiService operationId: procedureListProcedureLinkedPatient 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/Osdk.ProcedureProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - ProcedureApiService operationId: procedureGetProcedureLinkedPatient 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/Osdk.ProcedureProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Procedure.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/procedureStatus: get: tags: - ProcedureApiService operationId: procedureListProcedureLinkedProcedureStatus 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/Osdk.ProcedureProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureStatusResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/procedureStatus/{linkedObjectPrimaryKey}: get: tags: - ProcedureApiService operationId: procedureGetProcedureLinkedProcedureStatus 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/Osdk.ProcedureProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Procedure.ProcedureStatus" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/theatreBooking: get: tags: - ProcedureApiService operationId: procedureListProcedureLinkedTheatreBooking 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/Osdk.ProcedureProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreBookingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/theatreBooking/{linkedObjectPrimaryKey}: get: tags: - ProcedureApiService operationId: procedureGetProcedureLinkedTheatreBooking 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/Osdk.ProcedureProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Procedure.TheatreBooking" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/theatreSession: get: tags: - ProcedureApiService operationId: procedureListProcedureLinkedTheatreSession 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/Osdk.ProcedureProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/theatreSession/{linkedObjectPrimaryKey}: get: tags: - ProcedureApiService operationId: procedureGetProcedureLinkedTheatreSession 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/Osdk.ProcedureProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Procedure.TheatreSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/uecAttendance: get: tags: - ProcedureApiService operationId: procedureListProcedureLinkedUecAttendance 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/Osdk.ProcedureProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUecAttendanceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/uecAttendance/{linkedObjectPrimaryKey}: get: tags: - ProcedureApiService operationId: procedureGetProcedureLinkedUecAttendance 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/Osdk.ProcedureProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Procedure.UecAttendance" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/virtualWardStay: get: tags: - ProcedureApiService operationId: procedureListProcedureLinkedVirtualWardStay 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/Osdk.ProcedureProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListVirtualWardStayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Procedure/{primaryKey}/links/virtualWardStay/{linkedObjectPrimaryKey}: get: tags: - ProcedureApiService operationId: procedureGetProcedureLinkedVirtualWardStay 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/Osdk.ProcedureProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Procedure.VirtualWardStay" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureStatus: get: tags: - ProcedureStatusApiService operationId: procedureStatusListProcedureStatus 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/Osdk.ProcedureStatusProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureStatusResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureStatus/aggregate: post: tags: - ProcedureStatusApiService operationId: procedureStatusComputeProcedureStatusAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureStatus/count: post: tags: - ProcedureStatusApiService operationId: procedureStatusComputeProcedureStatusCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureStatus/search: post: tags: - ProcedureStatusApiService operationId: procedureStatusSearchProcedureStatus parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchProcedureStatusResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureStatus/{primaryKey}: get: tags: - ProcedureStatusApiService operationId: procedureStatusGetProcedureStatus parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ProcedureStatusProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ProcedureStatus" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureStatus/{primaryKey}/links/encounter: get: tags: - ProcedureStatusApiService operationId: procedureStatusListProcedureStatusLinkedEncounter 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/Osdk.ProcedureStatusProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureStatus/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}: get: tags: - ProcedureStatusApiService operationId: procedureStatusGetProcedureStatusLinkedEncounter 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/Osdk.ProcedureStatusProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ProcedureStatus.Encounter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureStatus/{primaryKey}/links/patient: get: tags: - ProcedureStatusApiService operationId: procedureStatusListProcedureStatusLinkedPatient 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/Osdk.ProcedureStatusProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureStatus/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - ProcedureStatusApiService operationId: procedureStatusGetProcedureStatusLinkedPatient 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/Osdk.ProcedureStatusProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ProcedureStatus.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureStatus/{primaryKey}/links/procedure: get: tags: - ProcedureStatusApiService operationId: procedureStatusListProcedureStatusLinkedProcedure 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/Osdk.ProcedureStatusProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureStatus/{primaryKey}/links/procedure/{linkedObjectPrimaryKey}: get: tags: - ProcedureStatusApiService operationId: procedureStatusGetProcedureStatusLinkedProcedure 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/Osdk.ProcedureStatusProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ProcedureStatus.Procedure" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureStatus/{primaryKey}/links/theatreBooking: get: tags: - ProcedureStatusApiService operationId: procedureStatusListProcedureStatusLinkedTheatreBooking 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/Osdk.ProcedureStatusProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreBookingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureStatus/{primaryKey}/links/theatreBooking/{linkedObjectPrimaryKey}: get: tags: - ProcedureStatusApiService operationId: procedureStatusGetProcedureStatusLinkedTheatreBooking 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/Osdk.ProcedureStatusProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ProcedureStatus.TheatreBooking" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureType: get: tags: - ProcedureTypeApiService operationId: procedureTypeListProcedureType 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/Osdk.ProcedureTypeProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureTypeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureType/aggregate: post: tags: - ProcedureTypeApiService operationId: procedureTypeComputeProcedureTypeAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureType/count: post: tags: - ProcedureTypeApiService operationId: procedureTypeComputeProcedureTypeCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureType/search: post: tags: - ProcedureTypeApiService operationId: procedureTypeSearchProcedureType parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchProcedureTypeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ProcedureType/{primaryKey}: get: tags: - ProcedureTypeApiService operationId: procedureTypeGetProcedureType parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ProcedureTypeProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ProcedureType" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/RadiologyExam: get: tags: - RadiologyExamApiService operationId: radiologyExamListRadiologyExam 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/Osdk.RadiologyExamProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListRadiologyExamResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/RadiologyExam/aggregate: post: tags: - RadiologyExamApiService operationId: radiologyExamComputeRadiologyExamAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/RadiologyExam/count: post: tags: - RadiologyExamApiService operationId: radiologyExamComputeRadiologyExamCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/RadiologyExam/search: post: tags: - RadiologyExamApiService operationId: radiologyExamSearchRadiologyExam parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchRadiologyExamResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/RadiologyExam/{primaryKey}: get: tags: - RadiologyExamApiService operationId: radiologyExamGetRadiologyExam parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.RadiologyExamProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.RadiologyExam" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/RadiologyExam/{primaryKey}/links/patient: get: tags: - RadiologyExamApiService operationId: radiologyExamListRadiologyExamLinkedPatient 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/Osdk.RadiologyExamProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/RadiologyExam/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - RadiologyExamApiService operationId: radiologyExamGetRadiologyExamLinkedPatient 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/Osdk.RadiologyExamProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/RadiologyExam.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral: get: tags: - ReferralApiService operationId: referralListReferral 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/Osdk.ReferralProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListReferralResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/aggregate: post: tags: - ReferralApiService operationId: referralComputeReferralAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/count: post: tags: - ReferralApiService operationId: referralComputeReferralCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/search: post: tags: - ReferralApiService operationId: referralSearchReferral parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchReferralResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/{primaryKey}: get: tags: - ReferralApiService operationId: referralGetReferral parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ReferralProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Referral" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/{primaryKey}/links/appointment: get: tags: - ReferralApiService operationId: referralListReferralLinkedAppointment 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/Osdk.ReferralProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAppointmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/{primaryKey}/links/appointment/{linkedObjectPrimaryKey}: get: tags: - ReferralApiService operationId: referralGetReferralLinkedAppointment 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/Osdk.ReferralProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Referral.Appointment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/{primaryKey}/links/ersService: get: tags: - ReferralApiService operationId: referralListReferralLinkedErsService 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/Osdk.ReferralProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListErsServiceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/{primaryKey}/links/ersService/{linkedObjectPrimaryKey}: get: tags: - ReferralApiService operationId: referralGetReferralLinkedErsService 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/Osdk.ReferralProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Referral.ErsService" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/{primaryKey}/links/outpatientActivity: get: tags: - ReferralApiService operationId: referralListReferralLinkedOutpatientActivity 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/Osdk.ReferralProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListOutpatientActivityResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/{primaryKey}/links/outpatientActivity/{linkedObjectPrimaryKey}: get: tags: - ReferralApiService operationId: referralGetReferralLinkedOutpatientActivity 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/Osdk.ReferralProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Referral.OutpatientActivity" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/{primaryKey}/links/patient: get: tags: - ReferralApiService operationId: referralListReferralLinkedPatient 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/Osdk.ReferralProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - ReferralApiService operationId: referralGetReferralLinkedPatient 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/Osdk.ReferralProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Referral.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/{primaryKey}/links/patientPathway: get: tags: - ReferralApiService operationId: referralListReferralLinkedPatientPathway 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/Osdk.ReferralProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Referral/{primaryKey}/links/patientPathway/{linkedObjectPrimaryKey}: get: tags: - ReferralApiService operationId: referralGetReferralLinkedPatientPathway 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/Osdk.ReferralProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Referral.PatientPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment: get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentListScoredAssessment 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/Osdk.ScoredAssessmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListScoredAssessmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/aggregate: post: tags: - ScoredAssessmentApiService operationId: scoredAssessmentComputeScoredAssessmentAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/count: post: tags: - ScoredAssessmentApiService operationId: scoredAssessmentComputeScoredAssessmentCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/search: post: tags: - ScoredAssessmentApiService operationId: scoredAssessmentSearchScoredAssessment parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchScoredAssessmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/{primaryKey}: get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentGetScoredAssessment parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ScoredAssessmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ScoredAssessment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/{primaryKey}/links/admission: get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentListScoredAssessmentLinkedAdmission 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/Osdk.ScoredAssessmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAdmissionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/{primaryKey}/links/admission/{linkedObjectPrimaryKey}: get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentGetScoredAssessmentLinkedAdmission 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/Osdk.ScoredAssessmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ScoredAssessment.Admission" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/{primaryKey}/links/appointment: get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentListScoredAssessmentLinkedAppointment 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/Osdk.ScoredAssessmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAppointmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/{primaryKey}/links/appointment/{linkedObjectPrimaryKey}: get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentGetScoredAssessmentLinkedAppointment 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/Osdk.ScoredAssessmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ScoredAssessment.Appointment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/{primaryKey}/links/consultantEpisode: get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentListScoredAssessmentLinkedConsultantEpisode 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/Osdk.ScoredAssessmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListConsultantEpisodeResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/{primaryKey}/links/consultantEpisode/{linkedObjectPrimaryKey} : get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentGetScoredAssessmentLinkedConsultantEpisode 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/Osdk.ScoredAssessmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ScoredAssessment.ConsultantEpisode" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/{primaryKey}/links/patient: get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentListScoredAssessmentLinkedPatient 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/Osdk.ScoredAssessmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentGetScoredAssessmentLinkedPatient 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/Osdk.ScoredAssessmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ScoredAssessment.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/{primaryKey}/links/uecAttendance: get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentListScoredAssessmentLinkedUecAttendance 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/Osdk.ScoredAssessmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUecAttendanceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/{primaryKey}/links/uecAttendance/{linkedObjectPrimaryKey}: get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentGetScoredAssessmentLinkedUecAttendance 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/Osdk.ScoredAssessmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ScoredAssessment.UecAttendance" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/{primaryKey}/links/virtualWardStay: get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentListScoredAssessmentLinkedVirtualWardStay 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/Osdk.ScoredAssessmentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListVirtualWardStayResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/ScoredAssessment/{primaryKey}/links/virtualWardStay/{linkedObjectPrimaryKey} : get: tags: - ScoredAssessmentApiService operationId: scoredAssessmentGetScoredAssessmentLinkedVirtualWardStay 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/Osdk.ScoredAssessmentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ScoredAssessment.VirtualWardStay" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Site: get: tags: - SiteApiService operationId: siteListSite 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/Osdk.SiteProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSiteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Site/aggregate: post: tags: - SiteApiService operationId: siteComputeSiteAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Site/count: post: tags: - SiteApiService operationId: siteComputeSiteCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Site/search: post: tags: - SiteApiService operationId: siteSearchSite parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchSiteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Site/{primaryKey}: get: tags: - SiteApiService operationId: siteGetSite parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.SiteProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Site" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Site/{primaryKey}/links/ccsBaseProductTeam: get: tags: - SiteApiService operationId: siteListSiteLinkedCcsBaseProductTeam 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/Osdk.SiteProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmTeamResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Site/{primaryKey}/links/ccsBaseProductTeam/{linkedObjectPrimaryKey}: get: tags: - SiteApiService operationId: siteGetSiteLinkedCcsBaseProductTeam 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/Osdk.SiteProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Site.CdmTeam" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Site/{primaryKey}/links/ersService: get: tags: - SiteApiService operationId: siteListSiteLinkedErsService 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/Osdk.SiteProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListErsServiceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Site/{primaryKey}/links/ersService/{linkedObjectPrimaryKey}: get: tags: - SiteApiService operationId: siteGetSiteLinkedErsService 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/Osdk.SiteProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Site.ErsService" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Site/{primaryKey}/links/patientPathways: get: tags: - SiteApiService operationId: siteListSiteLinkedPatientPathways 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/Osdk.SiteProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Site/{primaryKey}/links/patientPathways/{linkedObjectPrimaryKey}: get: tags: - SiteApiService operationId: siteGetSiteLinkedPatientPathways 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/Osdk.SiteProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Site.PatientPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty: get: tags: - SpecialtyApiService operationId: specialtyListSpecialty 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/Osdk.SpecialtyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSpecialtyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/aggregate: post: tags: - SpecialtyApiService operationId: specialtyComputeSpecialtyAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/count: post: tags: - SpecialtyApiService operationId: specialtyComputeSpecialtyCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/search: post: tags: - SpecialtyApiService operationId: specialtySearchSpecialty parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchSpecialtyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}: get: tags: - SpecialtyApiService operationId: specialtyGetSpecialty parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.SpecialtyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Specialty" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/bookingRequest: get: tags: - SpecialtyApiService operationId: specialtyListSpecialtyLinkedBookingRequest 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/Osdk.SpecialtyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBookingRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/bookingRequest/{linkedObjectPrimaryKey}: get: tags: - SpecialtyApiService operationId: specialtyGetSpecialtyLinkedBookingRequest 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/Osdk.SpecialtyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Specialty.BookingRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/ccsBaseProductTeam: get: tags: - SpecialtyApiService operationId: specialtyListSpecialtyLinkedCcsBaseProductTeam 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/Osdk.SpecialtyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCdmTeamResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/ccsBaseProductTeam/{linkedObjectPrimaryKey}: get: tags: - SpecialtyApiService operationId: specialtyGetSpecialtyLinkedCcsBaseProductTeam 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/Osdk.SpecialtyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Specialty.CdmTeam" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/clinicType: get: tags: - SpecialtyApiService operationId: specialtyListSpecialtyLinkedClinicType 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/Osdk.SpecialtyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListClinicTypeResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/clinicType/{linkedObjectPrimaryKey}: get: tags: - SpecialtyApiService operationId: specialtyGetSpecialtyLinkedClinicType 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/Osdk.SpecialtyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Specialty.ClinicType" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/diagnosticsWaitlistEntries: get: tags: - SpecialtyApiService operationId: specialtyListSpecialtyLinkedDiagnosticsWaitlistEntries 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/Osdk.SpecialtyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListDiagnosticsWaitlistEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/diagnosticsWaitlistEntries/{linkedObjectPrimaryKey} : get: tags: - SpecialtyApiService operationId: specialtyGetSpecialtyLinkedDiagnosticsWaitlistEntries 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/Osdk.SpecialtyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Specialty.DiagnosticsWaitlistEntry" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/encounter: get: tags: - SpecialtyApiService operationId: specialtyListSpecialtyLinkedEncounter 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/Osdk.SpecialtyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}: get: tags: - SpecialtyApiService operationId: specialtyGetSpecialtyLinkedEncounter 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/Osdk.SpecialtyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Specialty.Encounter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/ersService: get: tags: - SpecialtyApiService operationId: specialtyListSpecialtyLinkedErsService 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/Osdk.SpecialtyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListErsServiceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/ersService/{linkedObjectPrimaryKey}: get: tags: - SpecialtyApiService operationId: specialtyGetSpecialtyLinkedErsService 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/Osdk.SpecialtyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Specialty.ErsService" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/outpatientActivity: get: tags: - SpecialtyApiService operationId: specialtyListSpecialtyLinkedOutpatientActivity 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/Osdk.SpecialtyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListOutpatientActivityResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/outpatientActivity/{linkedObjectPrimaryKey}: get: tags: - SpecialtyApiService operationId: specialtyGetSpecialtyLinkedOutpatientActivity 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/Osdk.SpecialtyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Specialty.OutpatientActivity" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/patientPathway: get: tags: - SpecialtyApiService operationId: specialtyListSpecialtyLinkedPatientPathway 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/Osdk.SpecialtyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/patientPathway/{linkedObjectPrimaryKey}: get: tags: - SpecialtyApiService operationId: specialtyGetSpecialtyLinkedPatientPathway 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/Osdk.SpecialtyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Specialty.PatientPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/theatreSession: get: tags: - SpecialtyApiService operationId: specialtyListSpecialtyLinkedTheatreSession 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/Osdk.SpecialtyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/theatreSession/{linkedObjectPrimaryKey}: get: tags: - SpecialtyApiService operationId: specialtyGetSpecialtyLinkedTheatreSession 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/Osdk.SpecialtyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Specialty.TheatreSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/userPreference: get: tags: - SpecialtyApiService operationId: specialtyListSpecialtyLinkedUserPreference 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/Osdk.SpecialtyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUserPreferenceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/userPreference/{linkedObjectPrimaryKey}: get: tags: - SpecialtyApiService operationId: specialtyGetSpecialtyLinkedUserPreference 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/Osdk.SpecialtyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Specialty.UserPreference" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/validatedChangelog: get: tags: - SpecialtyApiService operationId: specialtyListSpecialtyLinkedValidatedChangelog 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/Osdk.SpecialtyProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListValidatedChangelogResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Specialty/{primaryKey}/links/validatedChangelog/{linkedObjectPrimaryKey}: get: tags: - SpecialtyApiService operationId: specialtyGetSpecialtyLinkedValidatedChangelog 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/Osdk.SpecialtyProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Specialty.ValidatedChangelog" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/StaffUnavailability: get: tags: - StaffUnavailabilityApiService operationId: staffUnavailabilityListStaffUnavailability 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/Osdk.StaffUnavailabilityProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListStaffUnavailabilityResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/StaffUnavailability/aggregate: post: tags: - StaffUnavailabilityApiService operationId: staffUnavailabilityComputeStaffUnavailabilityAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/StaffUnavailability/count: post: tags: - StaffUnavailabilityApiService operationId: staffUnavailabilityComputeStaffUnavailabilityCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/StaffUnavailability/search: post: tags: - StaffUnavailabilityApiService operationId: staffUnavailabilitySearchStaffUnavailability parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchStaffUnavailabilityResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/StaffUnavailability/{primaryKey}: get: tags: - StaffUnavailabilityApiService operationId: staffUnavailabilityGetStaffUnavailability parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.StaffUnavailabilityProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.StaffUnavailability" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/StaffUnavailability/{primaryKey}/links/careProfessional: get: tags: - StaffUnavailabilityApiService operationId: staffUnavailabilityListStaffUnavailabilityLinkedCareProfessional 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/Osdk.StaffUnavailabilityProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/StaffUnavailability/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey} : get: tags: - StaffUnavailabilityApiService operationId: staffUnavailabilityGetStaffUnavailabilityLinkedCareProfessional 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/Osdk.StaffUnavailabilityProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/StaffUnavailability.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TestResult: get: tags: - TestResultApiService operationId: testResultListTestResult 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/Osdk.TestResultProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTestResultResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TestResult/aggregate: post: tags: - TestResultApiService operationId: testResultComputeTestResultAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TestResult/count: post: tags: - TestResultApiService operationId: testResultComputeTestResultCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/TestResult/search: post: tags: - TestResultApiService operationId: testResultSearchTestResult parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchTestResultResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TestResult/{primaryKey}: get: tags: - TestResultApiService operationId: testResultGetTestResult parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.TestResultProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.TestResult" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TestResult/{primaryKey}/links/patient: get: tags: - TestResultApiService operationId: testResultListTestResultLinkedPatient 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/Osdk.TestResultProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TestResult/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - TestResultApiService operationId: testResultGetTestResultLinkedPatient 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/Osdk.TestResultProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TestResult.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TestResult/{primaryKey}/links/uecAttendance: get: tags: - TestResultApiService operationId: testResultListTestResultLinkedUecAttendance 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/Osdk.TestResultProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUecAttendanceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TestResult/{primaryKey}/links/uecAttendance/{linkedObjectPrimaryKey}: get: tags: - TestResultApiService operationId: testResultGetTestResultLinkedUecAttendance 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/Osdk.TestResultProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TestResult.UecAttendance" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking: get: tags: - TheatreBookingApiService operationId: theatreBookingListTheatreBooking 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/Osdk.TheatreBookingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreBookingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/aggregate: post: tags: - TheatreBookingApiService operationId: theatreBookingComputeTheatreBookingAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/count: post: tags: - TheatreBookingApiService operationId: theatreBookingComputeTheatreBookingCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/search: post: tags: - TheatreBookingApiService operationId: theatreBookingSearchTheatreBooking parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchTheatreBookingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}: get: tags: - TheatreBookingApiService operationId: theatreBookingGetTheatreBooking parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.TheatreBookingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.TheatreBooking" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/bookingRequest: get: tags: - TheatreBookingApiService operationId: theatreBookingListTheatreBookingLinkedBookingRequest 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/Osdk.TheatreBookingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBookingRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/bookingRequest/{linkedObjectPrimaryKey}: get: tags: - TheatreBookingApiService operationId: theatreBookingGetTheatreBookingLinkedBookingRequest 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/Osdk.TheatreBookingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreBooking.BookingRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/careProfessional: get: tags: - TheatreBookingApiService operationId: theatreBookingListTheatreBookingLinkedCareProfessional 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/Osdk.TheatreBookingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey} : get: tags: - TheatreBookingApiService operationId: theatreBookingGetTheatreBookingLinkedCareProfessional 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/Osdk.TheatreBookingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreBooking.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/ealEntry: get: tags: - TheatreBookingApiService operationId: theatreBookingListTheatreBookingLinkedEalEntry 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/Osdk.TheatreBookingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEalEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/ealEntry/{linkedObjectPrimaryKey}: get: tags: - TheatreBookingApiService operationId: theatreBookingGetTheatreBookingLinkedEalEntry 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/Osdk.TheatreBookingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreBooking.EalEntry" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/encounter: get: tags: - TheatreBookingApiService operationId: theatreBookingListTheatreBookingLinkedEncounter 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/Osdk.TheatreBookingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}: get: tags: - TheatreBookingApiService operationId: theatreBookingGetTheatreBookingLinkedEncounter 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/Osdk.TheatreBookingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreBooking.Encounter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/patient: get: tags: - TheatreBookingApiService operationId: theatreBookingListTheatreBookingLinkedPatient 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/Osdk.TheatreBookingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - TheatreBookingApiService operationId: theatreBookingGetTheatreBookingLinkedPatient 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/Osdk.TheatreBookingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreBooking.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/primaryProcedure: get: tags: - TheatreBookingApiService operationId: theatreBookingListTheatreBookingLinkedPrimaryProcedure 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/Osdk.TheatreBookingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/primaryProcedure/{linkedObjectPrimaryKey} : get: tags: - TheatreBookingApiService operationId: theatreBookingGetTheatreBookingLinkedPrimaryProcedure 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/Osdk.TheatreBookingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreBooking.Procedure" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/procedureStatus: get: tags: - TheatreBookingApiService operationId: theatreBookingListTheatreBookingLinkedProcedureStatus 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/Osdk.TheatreBookingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureStatusResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/procedureStatus/{linkedObjectPrimaryKey}: get: tags: - TheatreBookingApiService operationId: theatreBookingGetTheatreBookingLinkedProcedureStatus 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/Osdk.TheatreBookingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreBooking.ProcedureStatus" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/theatreSession: get: tags: - TheatreBookingApiService operationId: theatreBookingListTheatreBookingLinkedTheatreSession 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/Osdk.TheatreBookingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreBooking/{primaryKey}/links/theatreSession/{linkedObjectPrimaryKey}: get: tags: - TheatreBookingApiService operationId: theatreBookingGetTheatreBookingLinkedTheatreSession 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/Osdk.TheatreBookingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreBooking.TheatreSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession: get: tags: - TheatreSessionApiService operationId: theatreSessionListTheatreSession 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/Osdk.TheatreSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/aggregate: post: tags: - TheatreSessionApiService operationId: theatreSessionComputeTheatreSessionAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/count: post: tags: - TheatreSessionApiService operationId: theatreSessionComputeTheatreSessionCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/search: post: tags: - TheatreSessionApiService operationId: theatreSessionSearchTheatreSession parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchTheatreSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}: get: tags: - TheatreSessionApiService operationId: theatreSessionGetTheatreSession parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.TheatreSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.TheatreSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/bookingRequest: get: tags: - TheatreSessionApiService operationId: theatreSessionListTheatreSessionLinkedBookingRequest 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/Osdk.TheatreSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListBookingRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/bookingRequest/{linkedObjectPrimaryKey}: get: tags: - TheatreSessionApiService operationId: theatreSessionGetTheatreSessionLinkedBookingRequest 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/Osdk.TheatreSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreSession.BookingRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/careProfessionalAllAnaesthetists: get: tags: - TheatreSessionApiService operationId: theatreSessionListTheatreSessionLinkedCareProfessionalAllAnaesthetists 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/Osdk.TheatreSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/careProfessionalAllAnaesthetists/{linkedObjectPrimaryKey} : get: tags: - TheatreSessionApiService operationId: theatreSessionGetTheatreSessionLinkedCareProfessionalAllAnaesthetists 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/Osdk.TheatreSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreSession.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/careProfessionalAnaesthetist: get: tags: - TheatreSessionApiService operationId: theatreSessionListTheatreSessionLinkedCareProfessionalAnaesthetist 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/Osdk.TheatreSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/careProfessionalAnaesthetist/{linkedObjectPrimaryKey} : get: tags: - TheatreSessionApiService operationId: theatreSessionGetTheatreSessionLinkedCareProfessionalAnaesthetist 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/Osdk.TheatreSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreSession.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/careProfessionalConsultant: get: tags: - TheatreSessionApiService operationId: theatreSessionListTheatreSessionLinkedCareProfessionalConsultant 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/Osdk.TheatreSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/careProfessionalConsultant/{linkedObjectPrimaryKey} : get: tags: - TheatreSessionApiService operationId: theatreSessionGetTheatreSessionLinkedCareProfessionalConsultant 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/Osdk.TheatreSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreSession.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/careProfessionalsAllConsultants: get: tags: - TheatreSessionApiService operationId: theatreSessionListTheatreSessionLinkedCareProfessionalsAllConsultants 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/Osdk.TheatreSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/careProfessionalsAllConsultants/{linkedObjectPrimaryKey} : get: tags: - TheatreSessionApiService operationId: theatreSessionGetTheatreSessionLinkedCareProfessionalsAllConsultants 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/Osdk.TheatreSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreSession.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/procedure: get: tags: - TheatreSessionApiService operationId: theatreSessionListTheatreSessionLinkedProcedure 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/Osdk.TheatreSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/procedure/{linkedObjectPrimaryKey}: get: tags: - TheatreSessionApiService operationId: theatreSessionGetTheatreSessionLinkedProcedure 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/Osdk.TheatreSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreSession.Procedure" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/specialty: get: tags: - TheatreSessionApiService operationId: theatreSessionListTheatreSessionLinkedSpecialty 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/Osdk.TheatreSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSpecialtyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}: get: tags: - TheatreSessionApiService operationId: theatreSessionGetTheatreSessionLinkedSpecialty 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/Osdk.TheatreSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreSession.Specialty" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/theatreBooking: get: tags: - TheatreSessionApiService operationId: theatreSessionListTheatreSessionLinkedTheatreBooking 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/Osdk.TheatreSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreBookingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/theatreBooking/{linkedObjectPrimaryKey}: get: tags: - TheatreSessionApiService operationId: theatreSessionGetTheatreSessionLinkedTheatreBooking 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/Osdk.TheatreSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreSession.TheatreBooking" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/theatreSessionComment: get: tags: - TheatreSessionApiService operationId: theatreSessionListTheatreSessionLinkedTheatreSessionComment 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/Osdk.TheatreSessionProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreSessionCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSession/{primaryKey}/links/theatreSessionComment/{linkedObjectPrimaryKey} : get: tags: - TheatreSessionApiService operationId: theatreSessionGetTheatreSessionLinkedTheatreSessionComment 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/Osdk.TheatreSessionProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreSession.TheatreSessionComment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSessionComment: get: tags: - TheatreSessionCommentApiService operationId: theatreSessionCommentListTheatreSessionComment 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/Osdk.TheatreSessionCommentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreSessionCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSessionComment/aggregate: post: tags: - TheatreSessionCommentApiService operationId: theatreSessionCommentComputeTheatreSessionCommentAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSessionComment/count: post: tags: - TheatreSessionCommentApiService operationId: theatreSessionCommentComputeTheatreSessionCommentCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSessionComment/search: post: tags: - TheatreSessionCommentApiService operationId: theatreSessionCommentSearchTheatreSessionComment parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchTheatreSessionCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSessionComment/{primaryKey}: get: tags: - TheatreSessionCommentApiService operationId: theatreSessionCommentGetTheatreSessionComment parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.TheatreSessionCommentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.TheatreSessionComment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSessionComment/{primaryKey}/links/theatreSession: get: tags: - TheatreSessionCommentApiService operationId: theatreSessionCommentListTheatreSessionCommentLinkedTheatreSession 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/Osdk.TheatreSessionCommentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTheatreSessionResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/TheatreSessionComment/{primaryKey}/links/theatreSession/{linkedObjectPrimaryKey} : get: tags: - TheatreSessionCommentApiService operationId: theatreSessionCommentGetTheatreSessionCommentLinkedTheatreSession 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/Osdk.TheatreSessionCommentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TheatreSessionComment.TheatreSession" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TransferOfCareRequest: get: tags: - TransferOfCareRequestApiService operationId: transferOfCareRequestListTransferOfCareRequest 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/Osdk.TransferOfCareRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTransferOfCareRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TransferOfCareRequest/aggregate: post: tags: - TransferOfCareRequestApiService operationId: transferOfCareRequestComputeTransferOfCareRequestAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TransferOfCareRequest/count: post: tags: - TransferOfCareRequestApiService operationId: transferOfCareRequestComputeTransferOfCareRequestCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/TransferOfCareRequest/search: post: tags: - TransferOfCareRequestApiService operationId: transferOfCareRequestSearchTransferOfCareRequest parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchTransferOfCareRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TransferOfCareRequest/{primaryKey}: get: tags: - TransferOfCareRequestApiService operationId: transferOfCareRequestGetTransferOfCareRequest parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.TransferOfCareRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.TransferOfCareRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TransferOfCareRequest/{primaryKey}/links/destinationCareService: get: tags: - TransferOfCareRequestApiService operationId: transferOfCareRequestListTransferOfCareRequestLinkedDestinationCareService 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/Osdk.TransferOfCareRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareServiceResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/TransferOfCareRequest/{primaryKey}/links/destinationCareService/{linkedObjectPrimaryKey} : get: tags: - TransferOfCareRequestApiService operationId: transferOfCareRequestGetTransferOfCareRequestLinkedDestinationCareService 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/Osdk.TransferOfCareRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TransferOfCareRequest.CareService" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TransferOfCareRequest/{primaryKey}/links/requestedByCareService: get: tags: - TransferOfCareRequestApiService operationId: transferOfCareRequestListTransferOfCareRequestLinkedRequestedByCareService 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/Osdk.TransferOfCareRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareServiceResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/TransferOfCareRequest/{primaryKey}/links/requestedByCareService/{linkedObjectPrimaryKey} : get: tags: - TransferOfCareRequestApiService operationId: transferOfCareRequestGetTransferOfCareRequestLinkedRequestedByCareService 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/Osdk.TransferOfCareRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TransferOfCareRequest.CareService" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TransferOfCareRequest/{primaryKey}/links/resultingAdmission: get: tags: - TransferOfCareRequestApiService operationId: transferOfCareRequestListTransferOfCareRequestLinkedResultingAdmission 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/Osdk.TransferOfCareRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAdmissionResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/TransferOfCareRequest/{primaryKey}/links/resultingAdmission/{linkedObjectPrimaryKey} : get: tags: - TransferOfCareRequestApiService operationId: transferOfCareRequestGetTransferOfCareRequestLinkedResultingAdmission 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/Osdk.TransferOfCareRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TransferOfCareRequest.Admission" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TransferOfCareRequest/{primaryKey}/links/sourceAdmission: get: tags: - TransferOfCareRequestApiService operationId: transferOfCareRequestListTransferOfCareRequestLinkedSourceAdmission 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/Osdk.TransferOfCareRequestProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAdmissionResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/TransferOfCareRequest/{primaryKey}/links/sourceAdmission/{linkedObjectPrimaryKey} : get: tags: - TransferOfCareRequestApiService operationId: transferOfCareRequestGetTransferOfCareRequestLinkedSourceAdmission 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/Osdk.TransferOfCareRequestProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/TransferOfCareRequest.Admission" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TrustSetting: get: tags: - TrustSettingApiService operationId: trustSettingListTrustSetting 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/Osdk.TrustSettingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTrustSettingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TrustSetting/aggregate: post: tags: - TrustSettingApiService operationId: trustSettingComputeTrustSettingAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TrustSetting/count: post: tags: - TrustSettingApiService operationId: trustSettingComputeTrustSettingCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/TrustSetting/search: post: tags: - TrustSettingApiService operationId: trustSettingSearchTrustSetting parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchTrustSettingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/TrustSetting/{primaryKey}: get: tags: - TrustSettingApiService operationId: trustSettingGetTrustSetting parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.TrustSettingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.TrustSetting" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance: get: tags: - UecAttendanceApiService operationId: uecAttendanceListUecAttendance 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/Osdk.UecAttendanceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUecAttendanceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/aggregate: post: tags: - UecAttendanceApiService operationId: uecAttendanceComputeUecAttendanceAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/count: post: tags: - UecAttendanceApiService operationId: uecAttendanceComputeUecAttendanceCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/search: post: tags: - UecAttendanceApiService operationId: uecAttendanceSearchUecAttendance parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchUecAttendanceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}: get: tags: - UecAttendanceApiService operationId: uecAttendanceGetUecAttendance parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.UecAttendanceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.UecAttendance" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/assignedCareProfessionals: get: tags: - UecAttendanceApiService operationId: uecAttendanceListUecAttendanceLinkedAssignedCareProfessionals 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/Osdk.UecAttendanceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAssignedCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/assignedCareProfessionals/{linkedObjectPrimaryKey} : get: tags: - UecAttendanceApiService operationId: uecAttendanceGetUecAttendanceLinkedAssignedCareProfessionals 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/Osdk.UecAttendanceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/UecAttendance.AssignedCareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/emed3fitNotes: get: tags: - UecAttendanceApiService operationId: uecAttendanceListUecAttendanceLinkedEmed3fitNotes 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/Osdk.UecAttendanceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEMed3FitNoteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/emed3fitNotes/{linkedObjectPrimaryKey}: get: tags: - UecAttendanceApiService operationId: uecAttendanceGetUecAttendanceLinkedEmed3fitNotes 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/Osdk.UecAttendanceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/UecAttendance.EMed3FitNote" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/injuries: get: tags: - UecAttendanceApiService operationId: uecAttendanceListUecAttendanceLinkedInjuries 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/Osdk.UecAttendanceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListInjuryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/injuries/{linkedObjectPrimaryKey}: get: tags: - UecAttendanceApiService operationId: uecAttendanceGetUecAttendanceLinkedInjuries 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/Osdk.UecAttendanceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/UecAttendance.Injury" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/patient: get: tags: - UecAttendanceApiService operationId: uecAttendanceListUecAttendanceLinkedPatient 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/Osdk.UecAttendanceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - UecAttendanceApiService operationId: uecAttendanceGetUecAttendanceLinkedPatient 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/Osdk.UecAttendanceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/UecAttendance.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/patientDiagnoses: get: tags: - UecAttendanceApiService operationId: uecAttendanceListUecAttendanceLinkedPatientDiagnoses 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/Osdk.UecAttendanceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientDiagnosisResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/patientDiagnoses/{linkedObjectPrimaryKey}: get: tags: - UecAttendanceApiService operationId: uecAttendanceGetUecAttendanceLinkedPatientDiagnoses 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/Osdk.UecAttendanceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/UecAttendance.PatientDiagnosis" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/procedures: get: tags: - UecAttendanceApiService operationId: uecAttendanceListUecAttendanceLinkedProcedures 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/Osdk.UecAttendanceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/procedures/{linkedObjectPrimaryKey}: get: tags: - UecAttendanceApiService operationId: uecAttendanceGetUecAttendanceLinkedProcedures 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/Osdk.UecAttendanceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/UecAttendance.Procedure" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/scoredAssessments: get: tags: - UecAttendanceApiService operationId: uecAttendanceListUecAttendanceLinkedScoredAssessments 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/Osdk.UecAttendanceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListScoredAssessmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/scoredAssessments/{linkedObjectPrimaryKey} : get: tags: - UecAttendanceApiService operationId: uecAttendanceGetUecAttendanceLinkedScoredAssessments 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/Osdk.UecAttendanceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/UecAttendance.ScoredAssessment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/testResults: get: tags: - UecAttendanceApiService operationId: uecAttendanceListUecAttendanceLinkedTestResults 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/Osdk.UecAttendanceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListTestResultResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/testResults/{linkedObjectPrimaryKey}: get: tags: - UecAttendanceApiService operationId: uecAttendanceGetUecAttendanceLinkedTestResults 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/Osdk.UecAttendanceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/UecAttendance.TestResult" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/uecReferrals: get: tags: - UecAttendanceApiService operationId: uecAttendanceListUecAttendanceLinkedUecReferrals 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/Osdk.UecAttendanceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUecReferralResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecAttendance/{primaryKey}/links/uecReferrals/{linkedObjectPrimaryKey}: get: tags: - UecAttendanceApiService operationId: uecAttendanceGetUecAttendanceLinkedUecReferrals 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/Osdk.UecAttendanceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/UecAttendance.UecReferral" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecReferral: get: tags: - UecReferralApiService operationId: uecReferralListUecReferral 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/Osdk.UecReferralProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUecReferralResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecReferral/aggregate: post: tags: - UecReferralApiService operationId: uecReferralComputeUecReferralAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecReferral/count: post: tags: - UecReferralApiService operationId: uecReferralComputeUecReferralCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/UecReferral/search: post: tags: - UecReferralApiService operationId: uecReferralSearchUecReferral parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchUecReferralResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecReferral/{primaryKey}: get: tags: - UecReferralApiService operationId: uecReferralGetUecReferral parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.UecReferralProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.UecReferral" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecReferral/{primaryKey}/links/patient: get: tags: - UecReferralApiService operationId: uecReferralListUecReferralLinkedPatient 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/Osdk.UecReferralProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecReferral/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - UecReferralApiService operationId: uecReferralGetUecReferralLinkedPatient 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/Osdk.UecReferralProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/UecReferral.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecReferral/{primaryKey}/links/uecAttendance: get: tags: - UecReferralApiService operationId: uecReferralListUecReferralLinkedUecAttendance 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/Osdk.UecReferralProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUecAttendanceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UecReferral/{primaryKey}/links/uecAttendance/{linkedObjectPrimaryKey}: get: tags: - UecReferralApiService operationId: uecReferralGetUecReferralLinkedUecAttendance 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/Osdk.UecReferralProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/UecReferral.UecAttendance" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Url: get: tags: - UrlApiService operationId: urlListUrl 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/Osdk.UrlProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUrlResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Url/aggregate: post: tags: - UrlApiService operationId: urlComputeUrlAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Url/count: post: tags: - UrlApiService operationId: urlComputeUrlCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Url/search: post: tags: - UrlApiService operationId: urlSearchUrl parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchUrlResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Url/{primaryKey}: get: tags: - UrlApiService operationId: urlGetUrl parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.UrlProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Url" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UserPreference: get: tags: - UserPreferenceApiService operationId: userPreferenceListUserPreference 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/Osdk.UserPreferenceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListUserPreferenceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UserPreference/aggregate: post: tags: - UserPreferenceApiService operationId: userPreferenceComputeUserPreferenceAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UserPreference/count: post: tags: - UserPreferenceApiService operationId: userPreferenceComputeUserPreferenceCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/UserPreference/search: post: tags: - UserPreferenceApiService operationId: userPreferenceSearchUserPreference parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchUserPreferenceResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UserPreference/{primaryKey}: get: tags: - UserPreferenceApiService operationId: userPreferenceGetUserPreference parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.UserPreferenceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.UserPreference" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UserPreference/{primaryKey}/links/careProfessional: get: tags: - UserPreferenceApiService operationId: userPreferenceListUserPreferenceLinkedCareProfessional 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/Osdk.UserPreferenceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/UserPreference/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey} : get: tags: - UserPreferenceApiService operationId: userPreferenceGetUserPreferenceLinkedCareProfessional 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/Osdk.UserPreferenceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/UserPreference.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UserPreference/{primaryKey}/links/specialty: get: tags: - UserPreferenceApiService operationId: userPreferenceListUserPreferenceLinkedSpecialty 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/Osdk.UserPreferenceProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSpecialtyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/UserPreference/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}: get: tags: - UserPreferenceApiService operationId: userPreferenceGetUserPreferenceLinkedSpecialty 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/Osdk.UserPreferenceProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/UserPreference.Specialty" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangeLogComment: get: tags: - ValidatedChangeLogCommentApiService operationId: validatedChangeLogCommentListValidatedChangeLogComment 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/Osdk.ValidatedChangeLogCommentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListValidatedChangeLogCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangeLogComment/aggregate: post: tags: - ValidatedChangeLogCommentApiService operationId: validatedChangeLogCommentComputeValidatedChangeLogCommentAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangeLogComment/count: post: tags: - ValidatedChangeLogCommentApiService operationId: validatedChangeLogCommentComputeValidatedChangeLogCommentCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangeLogComment/search: post: tags: - ValidatedChangeLogCommentApiService operationId: validatedChangeLogCommentSearchValidatedChangeLogComment parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchValidatedChangeLogCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangeLogComment/{primaryKey}: get: tags: - ValidatedChangeLogCommentApiService operationId: validatedChangeLogCommentGetValidatedChangeLogComment parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ValidatedChangeLogCommentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ValidatedChangeLogComment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangeLogComment/{primaryKey}/links/validatedChangelog: get: tags: - ValidatedChangeLogCommentApiService operationId: validatedChangeLogCommentListValidatedChangeLogCommentLinkedValidatedChangelog 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/Osdk.ValidatedChangeLogCommentProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListValidatedChangelogResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangeLogComment/{primaryKey}/links/validatedChangelog/{linkedObjectPrimaryKey} : get: tags: - ValidatedChangeLogCommentApiService operationId: validatedChangeLogCommentGetValidatedChangeLogCommentLinkedValidatedChangelog 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/Osdk.ValidatedChangeLogCommentProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ValidatedChangeLogComment.ValidatedChangelog" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog: get: tags: - ValidatedChangelogApiService operationId: validatedChangelogListValidatedChangelog 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/Osdk.ValidatedChangelogProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListValidatedChangelogResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/aggregate: post: tags: - ValidatedChangelogApiService operationId: validatedChangelogComputeValidatedChangelogAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/count: post: tags: - ValidatedChangelogApiService operationId: validatedChangelogComputeValidatedChangelogCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/search: post: tags: - ValidatedChangelogApiService operationId: validatedChangelogSearchValidatedChangelog parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchValidatedChangelogResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/{primaryKey}: get: tags: - ValidatedChangelogApiService operationId: validatedChangelogGetValidatedChangelog parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.ValidatedChangelogProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ValidatedChangelog" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/{primaryKey}/links/careProfessional: get: tags: - ValidatedChangelogApiService operationId: validatedChangelogListValidatedChangelogLinkedCareProfessional 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/Osdk.ValidatedChangelogProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCareProfessionalResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/{primaryKey}/links/careProfessional/{linkedObjectPrimaryKey} : get: tags: - ValidatedChangelogApiService operationId: validatedChangelogGetValidatedChangelogLinkedCareProfessional 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/Osdk.ValidatedChangelogProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ValidatedChangelog.CareProfessional" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/{primaryKey}/links/changeLogRequest: get: tags: - ValidatedChangelogApiService operationId: validatedChangelogListValidatedChangelogLinkedChangeLogRequest 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/Osdk.ValidatedChangelogProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListChangeLogRequestResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/{primaryKey}/links/changeLogRequest/{linkedObjectPrimaryKey} : get: tags: - ValidatedChangelogApiService operationId: validatedChangelogGetValidatedChangelogLinkedChangeLogRequest 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/Osdk.ValidatedChangelogProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ValidatedChangelog.ChangeLogRequest" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/{primaryKey}/links/encounter: get: tags: - ValidatedChangelogApiService operationId: validatedChangelogListValidatedChangelogLinkedEncounter 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/Osdk.ValidatedChangelogProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}: get: tags: - ValidatedChangelogApiService operationId: validatedChangelogGetValidatedChangelogLinkedEncounter 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/Osdk.ValidatedChangelogProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ValidatedChangelog.Encounter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/{primaryKey}/links/specialty: get: tags: - ValidatedChangelogApiService operationId: validatedChangelogListValidatedChangelogLinkedSpecialty 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/Osdk.ValidatedChangelogProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListSpecialtyResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/{primaryKey}/links/specialty/{linkedObjectPrimaryKey}: get: tags: - ValidatedChangelogApiService operationId: validatedChangelogGetValidatedChangelogLinkedSpecialty 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/Osdk.ValidatedChangelogProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ValidatedChangelog.Specialty" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/{primaryKey}/links/validatedChangeLogComment: get: tags: - ValidatedChangelogApiService operationId: validatedChangelogListValidatedChangelogLinkedValidatedChangeLogComment 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/Osdk.ValidatedChangelogProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListValidatedChangeLogCommentResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/ValidatedChangelog/{primaryKey}/links/validatedChangeLogComment/{linkedObjectPrimaryKey} : get: tags: - ValidatedChangelogApiService operationId: validatedChangelogGetValidatedChangelogLinkedValidatedChangeLogComment 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/Osdk.ValidatedChangelogProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ValidatedChangelog.ValidatedChangeLogComment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWard: get: tags: - VirtualWardApiService operationId: virtualWardListVirtualWard 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/Osdk.VirtualWardProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListVirtualWardResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWard/aggregate: post: tags: - VirtualWardApiService operationId: virtualWardComputeVirtualWardAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWard/count: post: tags: - VirtualWardApiService operationId: virtualWardComputeVirtualWardCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWard/search: post: tags: - VirtualWardApiService operationId: virtualWardSearchVirtualWard parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchVirtualWardResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWard/{primaryKey}: get: tags: - VirtualWardApiService operationId: virtualWardGetVirtualWard parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.VirtualWardProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.VirtualWard" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWard/{primaryKey}/links/virtualWardStays: get: tags: - VirtualWardApiService operationId: virtualWardListVirtualWardLinkedVirtualWardStays 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/Osdk.VirtualWardProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListVirtualWardStayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWard/{primaryKey}/links/virtualWardStays/{linkedObjectPrimaryKey}: get: tags: - VirtualWardApiService operationId: virtualWardGetVirtualWardLinkedVirtualWardStays 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/Osdk.VirtualWardProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/VirtualWard.VirtualWardStay" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay: get: tags: - VirtualWardStayApiService operationId: virtualWardStayListVirtualWardStay 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/Osdk.VirtualWardStayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListVirtualWardStayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/aggregate: post: tags: - VirtualWardStayApiService operationId: virtualWardStayComputeVirtualWardStayAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/count: post: tags: - VirtualWardStayApiService operationId: virtualWardStayComputeVirtualWardStayCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/search: post: tags: - VirtualWardStayApiService operationId: virtualWardStaySearchVirtualWardStay parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchVirtualWardStayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/{primaryKey}: get: tags: - VirtualWardStayApiService operationId: virtualWardStayGetVirtualWardStay parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.VirtualWardStayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.VirtualWardStay" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/{primaryKey}/links/findings: get: tags: - VirtualWardStayApiService operationId: virtualWardStayListVirtualWardStayLinkedFindings 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/Osdk.VirtualWardStayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListFindingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/{primaryKey}/links/findings/{linkedObjectPrimaryKey}: get: tags: - VirtualWardStayApiService operationId: virtualWardStayGetVirtualWardStayLinkedFindings 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/Osdk.VirtualWardStayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/VirtualWardStay.Finding" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/{primaryKey}/links/observations: get: tags: - VirtualWardStayApiService operationId: virtualWardStayListVirtualWardStayLinkedObservations 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/Osdk.VirtualWardStayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListObservationResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/{primaryKey}/links/observations/{linkedObjectPrimaryKey}: get: tags: - VirtualWardStayApiService operationId: virtualWardStayGetVirtualWardStayLinkedObservations 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/Osdk.VirtualWardStayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/VirtualWardStay.Observation" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/{primaryKey}/links/patientDiagnoses: get: tags: - VirtualWardStayApiService operationId: virtualWardStayListVirtualWardStayLinkedPatientDiagnoses 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/Osdk.VirtualWardStayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientDiagnosisResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/{primaryKey}/links/patientDiagnoses/{linkedObjectPrimaryKey} : get: tags: - VirtualWardStayApiService operationId: virtualWardStayGetVirtualWardStayLinkedPatientDiagnoses 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/Osdk.VirtualWardStayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/VirtualWardStay.PatientDiagnosis" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/{primaryKey}/links/procedures: get: tags: - VirtualWardStayApiService operationId: virtualWardStayListVirtualWardStayLinkedProcedures 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/Osdk.VirtualWardStayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListProcedureResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/{primaryKey}/links/procedures/{linkedObjectPrimaryKey}: get: tags: - VirtualWardStayApiService operationId: virtualWardStayGetVirtualWardStayLinkedProcedures 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/Osdk.VirtualWardStayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/VirtualWardStay.Procedure" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/{primaryKey}/links/scoredAssessments: get: tags: - VirtualWardStayApiService operationId: virtualWardStayListVirtualWardStayLinkedScoredAssessments 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/Osdk.VirtualWardStayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListScoredAssessmentResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/{primaryKey}/links/scoredAssessments/{linkedObjectPrimaryKey} : get: tags: - VirtualWardStayApiService operationId: virtualWardStayGetVirtualWardStayLinkedScoredAssessments 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/Osdk.VirtualWardStayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/VirtualWardStay.ScoredAssessment" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/{primaryKey}/links/virtualWard: get: tags: - VirtualWardStayApiService operationId: virtualWardStayListVirtualWardStayLinkedVirtualWard 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/Osdk.VirtualWardStayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListVirtualWardResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/VirtualWardStay/{primaryKey}/links/virtualWard/{linkedObjectPrimaryKey}: get: tags: - VirtualWardStayApiService operationId: virtualWardStayGetVirtualWardStayLinkedVirtualWard 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/Osdk.VirtualWardStayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/VirtualWardStay.VirtualWard" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Waitlist: get: tags: - WaitlistApiService operationId: waitlistListWaitlist 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/Osdk.WaitlistProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListWaitlistResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Waitlist/aggregate: post: tags: - WaitlistApiService operationId: waitlistComputeWaitlistAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Waitlist/count: post: tags: - WaitlistApiService operationId: waitlistComputeWaitlistCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Waitlist/search: post: tags: - WaitlistApiService operationId: waitlistSearchWaitlist parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchWaitlistResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Waitlist/{primaryKey}: get: tags: - WaitlistApiService operationId: waitlistGetWaitlist parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.WaitlistProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Waitlist" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Waitlist/{primaryKey}/links/waitlistEntries: get: tags: - WaitlistApiService operationId: waitlistListWaitlistLinkedWaitlistEntries 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/Osdk.WaitlistProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListWaitlistEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Waitlist/{primaryKey}/links/waitlistEntries/{linkedObjectPrimaryKey}: get: tags: - WaitlistApiService operationId: waitlistGetWaitlistLinkedWaitlistEntries 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/Osdk.WaitlistProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Waitlist.WaitlistEntry" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WaitlistEntry: get: tags: - WaitlistEntryApiService operationId: waitlistEntryListWaitlistEntry 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/Osdk.WaitlistEntryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListWaitlistEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WaitlistEntry/aggregate: post: tags: - WaitlistEntryApiService operationId: waitlistEntryComputeWaitlistEntryAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WaitlistEntry/count: post: tags: - WaitlistEntryApiService operationId: waitlistEntryComputeWaitlistEntryCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/WaitlistEntry/search: post: tags: - WaitlistEntryApiService operationId: waitlistEntrySearchWaitlistEntry parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchWaitlistEntryResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WaitlistEntry/{primaryKey}: get: tags: - WaitlistEntryApiService operationId: waitlistEntryGetWaitlistEntry parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.WaitlistEntryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.WaitlistEntry" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WaitlistEntry/{primaryKey}/links/encounter: get: tags: - WaitlistEntryApiService operationId: waitlistEntryListWaitlistEntryLinkedEncounter 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/Osdk.WaitlistEntryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListEncounterResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WaitlistEntry/{primaryKey}/links/encounter/{linkedObjectPrimaryKey}: get: tags: - WaitlistEntryApiService operationId: waitlistEntryGetWaitlistEntryLinkedEncounter 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/Osdk.WaitlistEntryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/WaitlistEntry.Encounter" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WaitlistEntry/{primaryKey}/links/outpatientActivity: get: tags: - WaitlistEntryApiService operationId: waitlistEntryListWaitlistEntryLinkedOutpatientActivity 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/Osdk.WaitlistEntryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListOutpatientActivityResponse" security: - BearerAuth: [] x-releaseStage: STABLE ? /api/v2/ontologies/palantirukhealth-ontology/objects/WaitlistEntry/{primaryKey}/links/outpatientActivity/{linkedObjectPrimaryKey} : get: tags: - WaitlistEntryApiService operationId: waitlistEntryGetWaitlistEntryLinkedOutpatientActivity 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/Osdk.WaitlistEntryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/WaitlistEntry.OutpatientActivity" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WaitlistEntry/{primaryKey}/links/waitlist: get: tags: - WaitlistEntryApiService operationId: waitlistEntryListWaitlistEntryLinkedWaitlist 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/Osdk.WaitlistEntryProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListWaitlistResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WaitlistEntry/{primaryKey}/links/waitlist/{linkedObjectPrimaryKey}: get: tags: - WaitlistEntryApiService operationId: waitlistEntryGetWaitlistEntryLinkedWaitlist 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/Osdk.WaitlistEntryProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/WaitlistEntry.Waitlist" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Ward: get: tags: - WardApiService operationId: wardListWard 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/Osdk.WardProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListWardResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Ward/aggregate: post: tags: - WardApiService operationId: wardComputeWardAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Ward/count: post: tags: - WardApiService operationId: wardComputeWardCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/Ward/search: post: tags: - WardApiService operationId: wardSearchWard parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchWardResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Ward/{primaryKey}: get: tags: - WardApiService operationId: wardGetWard parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.WardProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.Ward" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Ward/{primaryKey}/links/wardStays: get: tags: - WardApiService operationId: wardListWardLinkedWardStays 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/Osdk.WardProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListWardStayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/Ward/{primaryKey}/links/wardStays/{linkedObjectPrimaryKey}: get: tags: - WardApiService operationId: wardGetWardLinkedWardStays 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/Osdk.WardProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ward.WardStay" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WardStay: get: tags: - WardStayApiService operationId: wardStayListWardStay 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/Osdk.WardStayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListWardStayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WardStay/aggregate: post: tags: - WardStayApiService operationId: wardStayComputeWardStayAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WardStay/count: post: tags: - WardStayApiService operationId: wardStayComputeWardStayCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/WardStay/search: post: tags: - WardStayApiService operationId: wardStaySearchWardStay parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchWardStayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WardStay/{primaryKey}: get: tags: - WardStayApiService operationId: wardStayGetWardStay parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.WardStayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.WardStay" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WardStay/{primaryKey}/links/admission: get: tags: - WardStayApiService operationId: wardStayListWardStayLinkedAdmission 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/Osdk.WardStayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListAdmissionResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WardStay/{primaryKey}/links/admission/{linkedObjectPrimaryKey}: get: tags: - WardStayApiService operationId: wardStayGetWardStayLinkedAdmission 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/Osdk.WardStayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/WardStay.Admission" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WardStay/{primaryKey}/links/patient: get: tags: - WardStayApiService operationId: wardStayListWardStayLinkedPatient 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/Osdk.WardStayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListPatientResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WardStay/{primaryKey}/links/patient/{linkedObjectPrimaryKey}: get: tags: - WardStayApiService operationId: wardStayGetWardStayLinkedPatient 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/Osdk.WardStayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/WardStay.Patient" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WardStay/{primaryKey}/links/ward: get: tags: - WardStayApiService operationId: wardStayListWardStayLinkedWard 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/Osdk.WardStayProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListWardResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/WardStay/{primaryKey}/links/ward/{linkedObjectPrimaryKey}: get: tags: - WardStayApiService operationId: wardStayGetWardStayLinkedWard 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/Osdk.WardStayProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/WardStay.Ward" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/mdtMeeting: get: tags: - MdtMeetingApiService operationId: mdtMeetingListMdtMeeting 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/Osdk.MdtMeetingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListMdtMeetingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/mdtMeeting/aggregate: post: tags: - MdtMeetingApiService operationId: mdtMeetingComputeMdtMeetingAggregation parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to aggregate objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/mdtMeeting/count: post: tags: - MdtMeetingApiService operationId: mdtMeetingComputeMdtMeetingCount parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The package version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to count the objects from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Ontologies.CountObjectsResponseV2" security: - BearerAuth: [] x-releaseStage: PRIVATE_BETA /api/v2/ontologies/palantirukhealth-ontology/objects/mdtMeeting/search: post: tags: - MdtMeetingApiService operationId: mdtMeetingSearchMdtMeeting parameters: - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. required: false schema: type: string - name: branch in: query description: | The Foundry branch to search objects from. If not specified, the default branch will be used. required: false schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Ontologies.SearchObjectsRequestV2" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.SearchMdtMeetingResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/mdtMeeting/{primaryKey}: get: tags: - MdtMeetingApiService operationId: mdtMeetingGetMdtMeeting parameters: - name: primaryKey in: path required: true schema: type: string - name: select in: query required: false schema: type: array items: $ref: "#/components/schemas/Osdk.MdtMeetingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to get the object from. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.MdtMeeting" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/mdtMeeting/{primaryKey}/links/cancerPathways: get: tags: - MdtMeetingApiService operationId: mdtMeetingListMdtMeetingLinkedCancerPathways 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/Osdk.MdtMeetingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListCancerPathwayResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/mdtMeeting/{primaryKey}/links/cancerPathways/{linkedObjectPrimaryKey}: get: tags: - MdtMeetingApiService operationId: mdtMeetingGetMdtMeetingLinkedCancerPathways 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/Osdk.MdtMeetingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/MdtMeeting.CancerPathway" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/mdtMeeting/{primaryKey}/links/mdtNotes: get: tags: - MdtMeetingApiService operationId: mdtMeetingListMdtMeetingLinkedMdtNotes 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/Osdk.MdtMeetingProperties" - name: orderBy in: query required: false schema: type: string - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: snapshot in: query description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. required: false schema: type: boolean - name: branch in: query description: | The Foundry branch to list linked objects from. If not specified, the default branch will be used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Osdk.ListMdtNoteResponse" security: - BearerAuth: [] x-releaseStage: STABLE /api/v2/ontologies/palantirukhealth-ontology/objects/mdtMeeting/{primaryKey}/links/mdtNotes/{linkedObjectPrimaryKey}: get: tags: - MdtMeetingApiService operationId: mdtMeetingGetMdtMeetingLinkedMdtNotes 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/Osdk.MdtMeetingProperties" - name: sdkPackageRid in: query description: | The package rid of the generated SDK. required: false schema: type: string - name: sdkVersion in: query description: | The version of the generated SDK. 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 - name: branch in: query description: | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. required: false schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/MdtMeeting.MdtNote" security: - BearerAuth: [] x-releaseStage: STABLE components: schemas: Admission.Birth: type: object properties: admissionId: type: string babyPatientId: type: string birthId: type: string birthSequenceNumber: type: integer birthWeightGrams: type: integer deliveryMethod: type: string deliveryMethodCode: type: string deliveryMethodLocalCode: type: string gestationLengthWeeks: type: integer isStillBirth: type: boolean labourId: type: string liveOrStillBirth: type: string liveOrStillBirthCode: type: string liveOrStillBirthLocalCode: type: string pregnancyId: type: string resuscitationMethod: type: string resuscitationMethodCode: type: string resuscitationMethodLocalCode: type: string rvGroupIds: type: array nullable: true items: type: string statusOfPersonConductingDelivery: type: string statusOfPersonConductingDeliveryCode: type: string statusOfPersonConductingDeliveryLocalCode: type: string Admission.ConsultantEpisode: type: object properties: admissionId: type: string consultantEpisodeExternalId: type: string consultantEpisodeId: type: string consultantEpisodeSequenceNumber: type: integer endTimestamp: type: string format: date-time healthcareProvider: type: string healthcareProviderOdsCode: type: string patientId: type: string psychiatricPatientStatus: type: string psychiatricPatientStatusCode: type: string psychiatricPatientStatusLocalCode: type: string rehabilitationAssessmentTeamType: type: string rehabilitationAssessmentTeamTypeCode: type: string rehabilitationAssessmentTeamTypeLocalCode: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time totalNumberOfRehabilitationDays: type: integer totalNumberOfSpecialistPalliativeCareDays: type: integer treatmentFunction: type: string treatmentFunctionCode: type: string Admission.CriticalCarePeriod: type: object properties: admissionId: type: string criticalCareAdmissionSource: type: string criticalCareAdmissionSourceCode: type: string criticalCareAdmissionSourceLocalCode: type: string criticalCareAdmissionType: type: string criticalCareAdmissionTypeCode: type: string criticalCareAdmissionTypeLocalCode: type: string criticalCareDischargeDestination: type: string criticalCareDischargeDestinationCode: type: string criticalCareDischargeDestinationLocalCode: type: string criticalCareDischargeLocation: type: string criticalCareDischargeLocationCode: type: string criticalCareDischargeLocationLocalCode: type: string criticalCareDischargeStatus: type: string criticalCareDischargeStatusCode: type: string criticalCareDischargeStatusLocalCode: type: string criticalCarePeriodId: type: string criticalCarePeriodType: type: string criticalCareSourceLocation: type: string criticalCareSourceLocationCode: type: string criticalCareSourceLocationLocalCode: type: string criticalCareUnitFunction: type: string criticalCareUnitFunctionCode: type: string criticalCareUnitFunctionLocalCode: type: string dischargeTimestamp: type: string format: date-time maxNumberOfOrganSystemsSupportedOnOneDay: type: integer patientId: type: string readyForDischargeTimestamp: type: string format: date-time rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time totalNumberOfAdvancedCardiovascularSupportDays: type: integer totalNumberOfAdvancedRespiratorySupportDays: type: integer totalNumberOfBasicCardiovascularSupportDays: type: integer totalNumberOfBasicRespiratorySupportDays: type: integer totalNumberOfDermatologicalSupportDays: type: integer totalNumberOfGastrointestinalSupportDays: type: integer totalNumberOfLevel2CareDays: type: integer totalNumberOfLevel3CareDays: type: integer totalNumberOfLiverSupportDays: type: integer totalNumberOfNeurologicalSupportDays: type: integer totalNumberOfRenalSupportDays: type: integer unitBedConfiguration: type: string unitBedConfigurationCode: type: string unitBedConfigurationLocalCode: type: string Admission.EMed3FitNote: type: object properties: admissionId: type: string applicablePeriodDurationDays: type: integer appointmentId: type: string assessmentDate: type: string format: date condition: type: string conditionIcd10Code: type: string conditionSnomedCtCode: type: string emed3FitNoteId: type: string emed3FitNoteIssuer: type: string emed3FitNoteIssuerCode: type: string emed3FitNoteIssuerLocalCode: type: string endDate: type: string format: date isFollowUpAssessmentRequired: type: boolean patientId: type: string recordedDate: type: string format: date rvGroupIds: type: array nullable: true items: type: string startDate: type: string format: date uecAttendanceId: type: string Admission.HomeLeave: type: object properties: admissionId: type: string consultantEpisodeId: type: string endTimestamp: type: string format: date-time homeLeaveId: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time Admission.Labour: type: object properties: actualDeliveryPlace: type: string actualDeliveryPlaceCode: type: string actualDeliveryPlaceLocalCode: type: string admissionId: type: string anaestheticGivenDuringLabourOrDelivery: type: string anaestheticGivenDuringLabourOrDeliveryCode: type: string anaestheticGivenDuringLabourOrDeliveryLocalCode: type: string anaestheticGivenPostLabourOrDelivery: type: string anaestheticGivenPostLabourOrDeliveryCode: type: string anaestheticGivenPostLabourOrDeliveryLocalCode: type: string consultantEpisodeId: type: string deliveryPlaceChangeReason: type: string deliveryPlaceChangeReasonCode: type: string deliveryPlaceChangeReasonLocalCode: type: string labourId: type: string labourOrDeliveryOnsetMethod: type: string labourOrDeliveryOnsetMethodCode: type: string labourOrDeliveryOnsetMethodLocalCode: type: string pregnancyId: type: string rvGroupIds: type: array nullable: true items: type: string Admission.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Admission.ScoredAssessment: type: object properties: admissionId: type: string appointmentId: type: string assessmentToolType: type: string assessmentToolTypeSnomedCtCode: type: string completionTimestamp: type: string format: date-time consultantEpisodeId: type: string patientId: type: string personScore: type: string rvGroupIds: type: array nullable: true items: type: string scoredAssessmentId: type: string uecAttendanceId: type: string virtualWardStayId: type: string Admission.TransferOfCareRequest: type: object properties: destinationCareServiceId: type: string requestAcceptedDate: type: string format: date requestCreatedDate: type: string format: date requestReceivedDate: type: string format: date requestedByCareServiceId: type: string resultingAdmissionId: type: string sourceAdmissionId: type: string status: type: string transferCompletedDate: type: string format: date transferOfCareRequestId: type: string transferReason: type: string updatedAt: type: string format: date-time updatedBy: type: string Admission.WardStay: type: object properties: admissionId: type: string endTimestamp: type: string format: date-time patientId: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time wardId: type: string wardStayId: type: string Appointment.AssignedCareProfessional: type: object properties: appointmentId: type: string assignedCareProfessionalId: type: string careProfessionalId: type: string clinicalResponsibilityTimestamp: type: string format: date-time consultantEpisodeId: type: string isResponsibleCareProfessional: type: boolean isResponsibleForEdDischarge: type: boolean rvGroupIds: type: array nullable: true items: type: string uecAttendanceId: type: string Appointment.ClinicLetter: type: object properties: appointmentId: type: string clinicLetterDate: type: string format: date-time clinicLetterId: type: string clinicLetterType: type: string consultantId: type: string hasLetterContent: type: boolean letterContent: type: string letterRid: $ref: "#/components/schemas/Core.MediaReference" patientId: type: string rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string status: type: string Appointment.ClinicSession: type: object properties: amPm: type: string bookingTeam: type: string cancellationReason: type: string cancellationTimestamp: type: string format: date-time careProfessionalId: type: string clinicCode: type: string clinicDisplayName: type: string clinicEndTimestamp: type: string format: date-time clinicFreeText: type: string clinicId: type: string clinicModality: type: string clinicName: type: string clinicStartTimestamp: type: string format: date-time clinicTypeActive: type: boolean clinicTypeId: type: string clinicTypeName: type: string clinicUtilisation: type: number format: double clinicUtilisationRag: type: string date: type: string format: date hasAnnualLeave: type: boolean hasAnnualLeaveString: type: string isCancelled: type: boolean isPrivate: type: boolean leadConsultant: type: string leadConsultantId: type: string location: type: string overbooked: type: boolean roomId: type: string rvGroupIds: type: array nullable: true items: type: string siteId: type: string siteName: type: string slotSpecialtyIds: type: array nullable: true items: type: string slotUtilisationPercentage: type: number format: double slotUtilisationRag: type: string specialtyId: type: string specialtyName: 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 nullable: true items: type: string treatmentFunctionNames: type: array nullable: true items: type: string type: type: string weekDelta: type: integer weekDeltaString: type: string weekDeltaStringDetails: type: string Appointment.EMed3FitNote: type: object properties: admissionId: type: string applicablePeriodDurationDays: type: integer appointmentId: type: string assessmentDate: type: string format: date condition: type: string conditionIcd10Code: type: string conditionSnomedCtCode: type: string emed3FitNoteId: type: string emed3FitNoteIssuer: type: string emed3FitNoteIssuerCode: type: string emed3FitNoteIssuerLocalCode: type: string endDate: type: string format: date isFollowUpAssessmentRequired: type: boolean patientId: type: string recordedDate: type: string format: date rvGroupIds: type: array nullable: true items: type: string startDate: type: string format: date uecAttendanceId: type: string Appointment.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Appointment.Referral: 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 isReferralToVirtualWard: type: boolean mrn: type: string pathwayId: type: array nullable: true items: type: string patientId: type: string patientIsOnCancerPathway: type: boolean presentingComplaint: type: string presentingComplaintIcd10Code: type: string presentingComplaintSnomedCtCode: type: string primaryCareProfessionalId: type: string primaryReferralReason: type: string primaryReferralReasonCode: type: string primaryReferralReasonToVirtualWardCode: type: string priority: type: string priorityCode: type: string priorityLocalCode: type: string referralId: type: string referralLetterContent: type: string referralLetterRid: $ref: "#/components/schemas/Core.MediaReference" referralNotes: type: string referralReceivedTimestamp: type: string format: date-time referralRejectionReason: type: string referralRejectionReasonCode: type: string referralRejectionTimestamp: type: string format: date-time referralSource: type: string referralSourceCode: type: string referralSourceLocalCode: type: string referralType: type: string referrerId: type: string referringOrganisation: type: string referringOrganisationOdsCode: type: string removed: type: boolean removedTimestamp: type: string format: date-time requestedAppointmentType: type: string requestedConsultationMechanism: type: string rttPathwayStatus: type: string rttPeriodEndDate: type: string format: date rttPeriodLength: type: integer rttPeriodStartDate: type: string format: date rvGroupIds: type: array nullable: true items: type: string serviceId: type: string serviceName: type: string serviceType: type: string serviceTypeRequested: type: string serviceTypeRequestedCode: type: string serviceTypeRequestedLocalCode: 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 treatmentFunction: type: string treatmentFunctionCode: type: string treatmentFunctionLocalCode: type: string trustOdsCode: type: string ubrn: type: string wasPatientReferredToDirectAccessService: type: boolean wasReferredByFirstContactPractitioner: type: boolean weeksWaiting: type: integer Appointment.ScoredAssessment: type: object properties: admissionId: type: string appointmentId: type: string assessmentToolType: type: string assessmentToolTypeSnomedCtCode: type: string completionTimestamp: type: string format: date-time consultantEpisodeId: type: string patientId: type: string personScore: type: string rvGroupIds: type: array nullable: true items: type: string scoredAssessmentId: type: string uecAttendanceId: type: string virtualWardStayId: type: string AssignedCareProfessional.Appointment: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string appointmentBookedReason: type: string appointmentBookedReasonCode: type: string appointmentBookedReasonLocalCode: type: string appointmentFreeText: type: string attendanceId: type: string attendanceStatus: type: string attendanceStatusCode: type: string attendanceStatusLocalCode: type: string bookedBy: type: string bookedDuration: type: integer bookingStatus: type: string cancellationReason: type: string cancelledBy: type: string cancerPriorityOrdering: type: integer category: type: string clinicId: type: string code: type: string consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string dateTimeBooked: type: string format: date-time dateTimeCancelled: type: string format: date-time earliestClinicallyAppropriateDate: type: string format: date earliestReasonableOfferDate: type: string format: date endDateTime: type: string format: date-time hasDateInTheLastNDays: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string isDateTimeBookedInTheLastNDays: type: boolean isDateTimeCancelledInTheLastNDays: type: boolean isFirstAppointment: type: boolean isOrderedDateInTheLastNDays: type: boolean isPoaAppointment: type: boolean isStartDateTimeInTheLastNDays: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time latestClinicallyAppropriateDate: type: string format: date orderedDate: type: string format: date outcomeOfAttendance: type: string outcomeOfAttendanceCode: type: string outcomeOfAttendanceLocalCode: type: string pathwayId: type: string 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 nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string startDateTime: type: string format: date-time treatmentFunctionCode: type: string treatmentFunctionLocalCode: type: string treatmentFunctionName: type: string type: type: string wasPatientOnPifuPathway: type: boolean wasPatientSubjectToRemoteMontitoring: type: boolean AssignedCareProfessional.CareProfessional: type: object properties: careProfessionalId: type: string careProfessionalLocalId: type: string isActive: type: boolean localSubSpecialties: type: array nullable: true items: type: string mainSpecialty: type: string mainSpecialtyCode: type: string name: type: string professionalRegistrationBody: type: string professionalRegistrationBodyCode: type: string professionalRegistrationEntryId: type: string role: type: string rvGroupIds: type: array nullable: true items: type: string AssignedCareProfessional.ConsultantEpisode: type: object properties: admissionId: type: string consultantEpisodeExternalId: type: string consultantEpisodeId: type: string consultantEpisodeSequenceNumber: type: integer endTimestamp: type: string format: date-time healthcareProvider: type: string healthcareProviderOdsCode: type: string patientId: type: string psychiatricPatientStatus: type: string psychiatricPatientStatusCode: type: string psychiatricPatientStatusLocalCode: type: string rehabilitationAssessmentTeamType: type: string rehabilitationAssessmentTeamTypeCode: type: string rehabilitationAssessmentTeamTypeLocalCode: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time totalNumberOfRehabilitationDays: type: integer totalNumberOfSpecialistPalliativeCareDays: type: integer treatmentFunction: type: string treatmentFunctionCode: type: string AssignedCareProfessional.UecAttendance: type: object properties: acuity: type: string acuitySnomedCtCode: type: string admissionId: type: string ambulanceCallId: type: string ambulanceIncidentId: type: string arrivalMode: type: string arrivalModeSnomedCtCode: type: string arrivalTimestamp: type: string format: date-time attendanceSource: type: string attendanceSourceSite: type: string attendanceSourceSiteOdsCode: type: string attendanceSourceSnomedCtCode: type: string chiefComplaint: type: string chiefComplaintSnomedCtCode: type: string clinicallyReadyToProceedTimestamp: type: string format: date-time consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string conveyingAmbulanceTrust: type: string conveyingAmbulanceTrustOdsCode: type: string decisionToAdmitTimestamp: type: string format: date-time departureTimestamp: type: string format: date-time dischargeDestination: type: string dischargeDestinationSnomedCtCode: type: string dischargeFollowUp: type: string dischargeFollowUpSnomedCtCode: type: string dischargeSite: type: string dischargeSiteOdsCode: type: string dischargeStatus: type: string dischargeStatusSnomedCtCode: type: string edExtendedCareEpisodeId: type: string emergencyCareDepartmentType: type: string emergencyCareDepartmentTypeCode: type: string emergencyCareDepartmentTypeLocalCode: type: string expectedTreatmentAllocationTimestamp: type: string format: date-time expectedTreatmentTimestamp: type: string format: date-time hasDischargeInformationBeenGiven: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string initialAssessmentTimestamp: type: string format: date-time patientId: type: string rvGroupIds: type: array nullable: true items: type: string safeguardingConcerns: type: array nullable: true items: type: string safeguardingConcernsSnomedCtCodes: type: array nullable: true items: type: string seenForTreatmentTimestamp: type: string format: date-time treatmentSite: type: string treatmentSiteOdsCode: type: string uecAttendanceExternalId: type: string uecAttendanceId: type: string urgentAndEmergencyCareAttendanceCategory: type: string urgentAndEmergencyCareAttendanceCategoryCode: type: string urgentAndEmergencyCareAttendanceCategoryLocalCode: type: string Birth.Admission: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string admissionExternalId: type: string admissionId: type: string admissionMethod: type: string admissionSource: type: string admissionSourceCode: type: string admissionSourceLocalCode: type: string admissionStatus: type: string admissionTimestamp: type: string format: date-time admissionTitle: type: string admissionType: type: string bedLocation: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string destinationOfDischargeLocalCode: type: string dischargeDestinationType: type: string dischargePathway: type: string dischargeReadyDate: type: string format: date dischargeTimestamp: type: string format: date-time ealEntryId: type: string encounterId: type: string estimatedDischargeDate: type: string format: date-time isDischargeTimeConfirmed: type: boolean localAuthority: type: string methodOfAdmission: type: string methodOfAdmissionCode: type: string methodOfAdmissionLocalCode: type: string methodOfDischarge: type: string methodOfDischargeCode: type: string methodOfDischargeLocalCode: type: string pathwayId: type: string patientClassification: type: string patientClassificationCode: type: string patientClassificationLocalCode: type: string patientId: type: string patientName: type: string rvGroupIds: type: array nullable: true items: type: string siteName: type: string specialtyId: type: string specialtyName: type: string startTimestamp: type: string format: date-time treatmentFunctionCode: type: string ward: type: string wasPatientDischargedToNhsAtHomeService: type: boolean Birth.Labour: type: object properties: actualDeliveryPlace: type: string actualDeliveryPlaceCode: type: string actualDeliveryPlaceLocalCode: type: string admissionId: type: string anaestheticGivenDuringLabourOrDelivery: type: string anaestheticGivenDuringLabourOrDeliveryCode: type: string anaestheticGivenDuringLabourOrDeliveryLocalCode: type: string anaestheticGivenPostLabourOrDelivery: type: string anaestheticGivenPostLabourOrDeliveryCode: type: string anaestheticGivenPostLabourOrDeliveryLocalCode: type: string consultantEpisodeId: type: string deliveryPlaceChangeReason: type: string deliveryPlaceChangeReasonCode: type: string deliveryPlaceChangeReasonLocalCode: type: string labourId: type: string labourOrDeliveryOnsetMethod: type: string labourOrDeliveryOnsetMethodCode: type: string labourOrDeliveryOnsetMethodLocalCode: type: string pregnancyId: type: string rvGroupIds: type: array nullable: true items: type: string Birth.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Birth.Pregnancy: type: object properties: antenatalResponsibleGpCareProfessionalId: type: string firstAntenatalAssessmentDate: type: string format: date intendedDeliveryPlace: type: string intendedDeliveryPlaceCode: type: string intendedDeliveryPlaceCodeLocalCode: type: string numberOfPreviousPregnanciesResultingInRegistrableBirths: type: integer patientId: type: string pregnancyId: type: string rvGroupIds: type: array nullable: true items: type: string BookingRequest.BookingRequestComment: type: object properties: bookingRequestId: type: string commentAction: type: string commentId: type: string commentMarkdown: type: string commentText: type: string commentTimestamp: type: string format: date-time commentUser: type: string tags: type: array nullable: true items: type: string BookingRequest.CareProfessional: type: object properties: careProfessionalId: type: string careProfessionalLocalId: type: string isActive: type: boolean localSubSpecialties: type: array nullable: true items: type: string mainSpecialty: type: string mainSpecialtyCode: type: string name: type: string professionalRegistrationBody: type: string professionalRegistrationBodyCode: type: string professionalRegistrationEntryId: type: string role: type: string rvGroupIds: type: array nullable: true items: type: string BookingRequest.Encounter: type: object properties: administrativeCategoryCode: type: string administrativeCategoryDescription: type: string admissionMethod: type: string admissionOfferTimestamp: type: string format: date-time admissionStatus: type: string admissionSubStatus: type: string admissionType: type: string atsTotalTheatreTime: type: integer calculatedTotalTheatreTime: type: integer cancerPriorityOrdering: type: integer createdBy: type: string createdDate: type: string format: date criticalCareBedStatus: type: string division: type: string ealId: type: string encounterFreeText: type: string encounterId: type: string encounterType: type: string estimatedTotalTheatreTime: type: integer externalId: type: string genericWaitlistEntryId: type: string hasDateInTheLastNDays: type: boolean 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 isAdmissionOfferTimestampInTheLastNDays: type: boolean isBooked: type: boolean isMetricEncounter: type: boolean isSuitableForPooledList: type: boolean isSurgicalOrderDateInTheLastNDays: type: boolean isTciDateInTheLastNDays: type: boolean issues: type: array nullable: true items: type: string lastCovidSwabBookingStatus: type: string lastCovidSwabOutcome: type: string lastMrsaSwabBookingStatus: type: string lastMrsaSwabOutcome: type: string lastPoaBookingStatus: type: string lastPoaExpiryDate: type: string format: date lastPoaOutcome: type: string lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string lastPoaScheduledOrAttendedDatetime: type: string format: date-time lastRefreshedAtSourceTimestamp: 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 periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string site: type: string siteId: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string surgicalOrderDate: type: string format: date 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 BookingRequest.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string BookingRequest.Specialty: type: object properties: isActiveSpecialty: type: boolean rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string theatreSpecialty: type: boolean BookingRequest.TheatreBooking: 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 lastPoaExpiryDate: type: string format: date lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string mrn: type: string patientId: type: string periOpRiskStratificationOutcome: type: string periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string status: type: string statusRender: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreSessionDate: type: string format: date theatreSessionId: type: string BookingRequest.TheatreSession: 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 anaestheticTypes: type: array nullable: true items: type: string anaesthetistIds: type: array nullable: true items: type: string anaesthetistNames: type: array nullable: true items: type: string anaesthetistRequired: type: boolean bookedMinutes: type: integer bookedUtilisation: type: number format: double bookedUtilisationStatus: type: string bookingCancellationsOnTheDayCount: type: integer bookingCancellationsTotalCount: type: integer cancellationReason: type: string cancelled: type: boolean comments: type: array nullable: true items: type: string consultantIds: type: array nullable: true items: type: string consultantLeaveStatus: type: string consultantNames: type: array nullable: true 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 plannedSessionMinutes: type: integer plannedSessionUtilisation: type: number format: double plannedStartTime: type: string format: date-time pooledList: type: boolean primaryAnaesthetistId: type: string primaryAnaesthetistName: type: string primaryConsultantId: type: string primaryConsultantName: type: string rvGroupIds: type: array nullable: true 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 BookingRequestComment.BookingRequest: type: object properties: action: type: string amPm: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserGroup: type: string assignedUserIds: type: array nullable: true items: type: string bookingRequestId: type: string closedAt: type: string format: date-time closedBy: type: string comment: type: string consultantId: type: string date: type: string format: date encounterEstimatedTotalTheatreTime: type: integer encounterId: type: string intendedPrimaryProcedureDescription: type: string intendedPrimaryProcedureFreeText: type: string mnemonic: type: string mrn: type: string personId: type: string reason: type: string specialtyId: type: string status: type: string taskDueDate: type: string format: date taskPriority: type: string taskType: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreName: type: string theatreSessionId: type: string theatreSessionPlannedDurationMinutes: type: integer theatreSessionPrimaryConsultantId: type: string timestamp: type: string format: date-time title: type: string type: type: string updatedAt: type: string format: date-time updatedBy: type: string userId: type: string CancerPathway.CancerTrackingComment: type: object properties: cancerPathwayId: type: string cancerTrackingCommentId: type: string commentText: type: string commentTitle: type: string createdAtTimestamp: type: string format: date-time createdBy: type: string dueDate: type: string format: date isLatest: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string status: type: string type: type: string CancerPathway.InterProviderTransfer: type: object properties: cancerPathwayId: type: string cancerPathwayIptDate: type: string format: date interProviderTransferId: type: string iptReason: type: string iptReceivedDate: type: string format: date iptReturnedComment: type: string iptReturnedDate: type: string format: date iptSentComment: type: string iptSentDate: type: string format: date iptSentOrReceived: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time mrn: type: string nhsNumber: type: string patientId: type: string receivingOrgName: type: string receivingOrgOdsCode: type: string rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string sendingOrg: type: string sendingOrgOdsCode: type: string sourceSystemNames: type: array nullable: true items: type: string CancerPathway.MdtNote: type: object properties: cancerPathwayId: type: string lastRefreshedAtSourceTimestamp: type: string format: date-time lastUpdatedTimestamp: type: string format: date-time mdtMeetingId: type: string mdtNoteId: type: string mdtNoteText: type: string noteType: type: string rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string CancerPathway.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string CancerPathway.mdtMeeting: type: object properties: lastRefreshedAtSourceTimestamp: type: string format: date-time mdtMeetingId: type: string mdtStatus: type: string meetingTimestamp: type: string format: date-time rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string CancerTrackingComment.CancerPathway: type: object properties: _24DayBreachDate: type: string format: date _28DayBreachDate: type: string format: date _31DayBreachDate: type: string format: date _62DayBreachDate: type: string format: date adjustedPathwayStartDate: type: string format: date birthDate: type: string format: date cancerPathwayId: type: string cancerSite: type: string cancerSubSite: type: string daysSinceAdjustedPathwayStart: type: integer daysSinceAdjustedPathwayStartBucket: type: string deathDate: type: string format: date decisionToTreatDate: type: string format: date diagnosis: type: string diagnosisDate: type: string format: date diagnosisIcd10Code: type: string firstName: type: string firstSeenDate: type: string format: date firstSeenSite: type: string firstSeenSiteOdsCode: type: string firstTreatmentDate: type: string format: date firstTreatmentType: type: string fullName: type: string hospitalSite: type: string hospitalSiteId: type: string is28DayPathwayOpen: type: boolean is31DayPathwayOpen: type: boolean is62DayPathwayOpen: type: boolean isAnyPathwayTypeOpen: type: boolean isBenign: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time mrn: type: string nhsNumber: type: string organisationSiteTreatment: type: string originalPathwayStartDate: type: string format: date pathwayClosedDate: type: string format: date pathwayStatus: type: string pathwayType: type: string patientId: type: string patientInformedDate: type: string format: date referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string surname: type: string title: type: string treatmentSite: type: string treatmentSiteOdsCode: type: string treatmentType: type: string upgradeDate: type: string format: date waitingTimeAdjustmentDays: type: integer CancerTreatment.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string CareProfessional.AssignedCareProfessional: type: object properties: appointmentId: type: string assignedCareProfessionalId: type: string careProfessionalId: type: string clinicalResponsibilityTimestamp: type: string format: date-time consultantEpisodeId: type: string isResponsibleCareProfessional: type: boolean isResponsibleForEdDischarge: type: boolean rvGroupIds: type: array nullable: true items: type: string uecAttendanceId: type: string CareProfessional.BookingRequest: type: object properties: action: type: string amPm: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserGroup: type: string assignedUserIds: type: array nullable: true items: type: string bookingRequestId: type: string closedAt: type: string format: date-time closedBy: type: string comment: type: string consultantId: type: string date: type: string format: date encounterEstimatedTotalTheatreTime: type: integer encounterId: type: string intendedPrimaryProcedureDescription: type: string intendedPrimaryProcedureFreeText: type: string mnemonic: type: string mrn: type: string personId: type: string reason: type: string specialtyId: type: string status: type: string taskDueDate: type: string format: date taskPriority: type: string taskType: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreName: type: string theatreSessionId: type: string theatreSessionPlannedDurationMinutes: type: integer theatreSessionPrimaryConsultantId: type: string timestamp: type: string format: date-time title: type: string type: type: string updatedAt: type: string format: date-time updatedBy: type: string userId: type: string CareProfessional.ClinicSession: type: object properties: amPm: type: string bookingTeam: type: string cancellationReason: type: string cancellationTimestamp: type: string format: date-time careProfessionalId: type: string clinicCode: type: string clinicDisplayName: type: string clinicEndTimestamp: type: string format: date-time clinicFreeText: type: string clinicId: type: string clinicModality: type: string clinicName: type: string clinicStartTimestamp: type: string format: date-time clinicTypeActive: type: boolean clinicTypeId: type: string clinicTypeName: type: string clinicUtilisation: type: number format: double clinicUtilisationRag: type: string date: type: string format: date hasAnnualLeave: type: boolean hasAnnualLeaveString: type: string isCancelled: type: boolean isPrivate: type: boolean leadConsultant: type: string leadConsultantId: type: string location: type: string overbooked: type: boolean roomId: type: string rvGroupIds: type: array nullable: true items: type: string siteId: type: string siteName: type: string slotSpecialtyIds: type: array nullable: true items: type: string slotUtilisationPercentage: type: number format: double slotUtilisationRag: type: string specialtyId: type: string specialtyName: 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 nullable: true items: type: string treatmentFunctionNames: type: array nullable: true items: type: string type: type: string weekDelta: type: integer weekDeltaString: type: string weekDeltaStringDetails: type: string CareProfessional.Encounter: type: object properties: administrativeCategoryCode: type: string administrativeCategoryDescription: type: string admissionMethod: type: string admissionOfferTimestamp: type: string format: date-time admissionStatus: type: string admissionSubStatus: type: string admissionType: type: string atsTotalTheatreTime: type: integer calculatedTotalTheatreTime: type: integer cancerPriorityOrdering: type: integer createdBy: type: string createdDate: type: string format: date criticalCareBedStatus: type: string division: type: string ealId: type: string encounterFreeText: type: string encounterId: type: string encounterType: type: string estimatedTotalTheatreTime: type: integer externalId: type: string genericWaitlistEntryId: type: string hasDateInTheLastNDays: type: boolean 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 isAdmissionOfferTimestampInTheLastNDays: type: boolean isBooked: type: boolean isMetricEncounter: type: boolean isSuitableForPooledList: type: boolean isSurgicalOrderDateInTheLastNDays: type: boolean isTciDateInTheLastNDays: type: boolean issues: type: array nullable: true items: type: string lastCovidSwabBookingStatus: type: string lastCovidSwabOutcome: type: string lastMrsaSwabBookingStatus: type: string lastMrsaSwabOutcome: type: string lastPoaBookingStatus: type: string lastPoaExpiryDate: type: string format: date lastPoaOutcome: type: string lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string lastPoaScheduledOrAttendedDatetime: type: string format: date-time lastRefreshedAtSourceTimestamp: 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 periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string site: type: string siteId: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string surgicalOrderDate: type: string format: date 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 CareProfessional.OutpatientActivity: 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 genericWaitlistEntryId: type: string isPrivate: type: boolean isReferral: type: boolean issues: type: array nullable: true 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 nullable: true 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 CareProfessional.PatientPathway: type: object properties: _104WeeksBreachDate: type: string format: date _18WeeksBreachDate: type: string format: date _52WeeksBreachDate: type: string format: date _65WeeksBreachDate: type: string format: date _78WeeksBreachDate: type: string format: date accessibilityFlags: type: array nullable: true items: type: string admissionMethodCode: type: string age: type: string format: long closureReason: type: string consultantId: type: string consultantName: type: string covidPriority: type: string covidPriorityDate: type: string format: date dataSource: type: string dateOfBirth: type: string format: date daysTo104WeekBreachDate: type: integer daysTo18WeekBreachDate: type: integer daysTo52WeekBreachDate: type: integer daysTo65WeekBreachDate: type: integer daysTo78WeekBreachDate: type: integer derivedPathwayType: type: string directorate: type: string division: type: string dtaDate: type: string format: date intendedProcedureDescription: type: string isActiveRttPathway: type: boolean isOpenPathway: type: boolean 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 latestEpisodeId: type: string latestPathwayStatusCodeNational: type: string latestPathwayStatusDescriptionNational: type: string latestPeriodEndDate: type: string format: date latestPeriodEndReason: type: string latestPeriodLengthDays: type: integer latestPeriodLengthWeeks: type: integer latestPeriodStartDate: type: string format: date latestPeriodStartReason: type: string latestProcedurePriorityCode: type: string latestReferralReceivedDate: type: string format: date latestRttPeriodId: type: string 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 originalReferralSpecialtyId: type: string originalReferralSpecialtyName: type: string owlClinicCode: type: string owlFlag: type: boolean owlGroupCode: type: string pathwayClass: type: string pathwayEndDate: type: string format: date pathwayId: type: string pathwayStage: type: string pathwayStartDate: type: string format: date pathwayStatus: type: string pathwaySubtype: type: string pathwayType: type: string patientDeceased: type: boolean patientId: type: string patientName: type: string ppid: type: string ppidIssuer: type: string ppidIssuerOdsCode: type: string prospectiveRttPeriodEndDate: type: string format: date prospectiveRttWeeksWait: type: integer referralDate: type: string format: date referralId: type: string referralPriority: type: string referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true 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 waitingTimeMeasurementType: type: string waitingTimeMeasurementTypeCode: type: string waitingTimeMeasurementTypeCodeLocalCode: type: string weeksTo104WeekBreachDate: type: integer weeksTo18WeekBreachDate: type: integer weeksTo52WeekBreachDate: type: integer weeksTo65WeekBreachDate: type: integer weeksTo78WeekBreachDate: type: integer weeksWaitSinceDtaDate: type: integer weeksWaitSinceLastPatientContact: type: integer weeksWaitToProspectiveRttPeriodEndDate: type: integer weeksWaitToTciDate: type: integer CareProfessional.Pregnancy: type: object properties: antenatalResponsibleGpCareProfessionalId: type: string firstAntenatalAssessmentDate: type: string format: date intendedDeliveryPlace: type: string intendedDeliveryPlaceCode: type: string intendedDeliveryPlaceCodeLocalCode: type: string numberOfPreviousPregnanciesResultingInRegistrableBirths: type: integer patientId: type: string pregnancyId: type: string rvGroupIds: type: array nullable: true items: type: string CareProfessional.Procedure: type: object properties: actualProcedureTimeKnifeToSkinClosure: type: integer actualProcedureTimeTotalTheatreTime: type: integer admissionId: type: string admissionMethodDescription: type: string anaestheticTypeToBeUsed: type: string anaesthetistRequired: type: boolean appointmentId: type: string consultantEpisodeId: type: string 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 procedure: type: string procedureDate: type: string format: date procedureId: type: string procedureOpcsCode: type: string procedureOrdered: type: integer procedureSnomedCtCode: type: string procedureTimeOrOrder: type: string procedureTimestamp: type: string format: date-time responsibleAnaesthetistCareProfessionalId: type: string rvGroupIds: type: array nullable: true items: type: string theatreSessionId: type: string title: type: string uecAttendanceId: type: string virtualWardStayId: type: string CareProfessional.StaffUnavailability: 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 nullable: true items: type: string title: type: string CareProfessional.TheatreBooking: 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 lastPoaExpiryDate: type: string format: date lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string mrn: type: string patientId: type: string periOpRiskStratificationOutcome: type: string periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string status: type: string statusRender: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreSessionDate: type: string format: date theatreSessionId: type: string CareProfessional.TheatreSession: 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 anaestheticTypes: type: array nullable: true items: type: string anaesthetistIds: type: array nullable: true items: type: string anaesthetistNames: type: array nullable: true items: type: string anaesthetistRequired: type: boolean bookedMinutes: type: integer bookedUtilisation: type: number format: double bookedUtilisationStatus: type: string bookingCancellationsOnTheDayCount: type: integer bookingCancellationsTotalCount: type: integer cancellationReason: type: string cancelled: type: boolean comments: type: array nullable: true items: type: string consultantIds: type: array nullable: true items: type: string consultantLeaveStatus: type: string consultantNames: type: array nullable: true 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 plannedSessionMinutes: type: integer plannedSessionUtilisation: type: number format: double plannedStartTime: type: string format: date-time pooledList: type: boolean primaryAnaesthetistId: type: string primaryAnaesthetistName: type: string primaryConsultantId: type: string primaryConsultantName: type: string rvGroupIds: type: array nullable: true 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 CareProfessional.UserPreference: type: object properties: cancerPathwayTags: type: array nullable: true items: type: string cancerPathwayTypes: type: array nullable: true items: type: string cancerSites: type: array nullable: true items: type: string defaultConsultants: type: array nullable: true items: type: string defaultRole: type: string defaultSites: type: array nullable: true items: type: string defaultSpecialties: type: array nullable: true items: type: string notificationChannels: type: array nullable: true items: type: string receiveChangelogRequestNotifications: type: boolean receiveSchedulingNotifications: type: boolean receiveSchedulingUpdateNotifications: type: boolean receiveTheatreManagementNotifications: type: boolean userId: type: string CareProfessional.ValidatedChangelog: type: object properties: actionType: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserGroup: type: string assignedUserIds: type: array nullable: true items: type: string careProfessionalId: type: string careProfessionalName: type: string changeLogId: type: string closedAt: type: string format: date-time closedBy: type: string commentUser: type: string comments: type: string daysOpen: type: integer description: type: string ealId: type: string encounterId: type: string externalId: type: string freeTextComments: type: string isRtt: type: boolean lastRefreshed: type: string format: date-time mrn: type: string newValue: type: string originatingWaitingListAlertRuleTypes: type: array nullable: true items: type: string originatingWaitingListAlertUniqueIds: type: array nullable: true items: type: string patientId: type: string patientName: type: string preResolved: type: boolean primaryConsultantId: type: string primaryConsultantName: type: string primaryEvidenceSource: type: string priority: type: string propertyToModify: type: string rcsClinicalHarmReview: type: string removalDate: type: string format: date removed: type: boolean requestedBy: type: string requiredAction: type: string resolved: type: boolean secondaryEvidenceSource: type: array nullable: true items: type: string siteId: type: string specialtyId: type: string specialtyName: type: string status: type: string statusUpdatedByUser: type: string statusUpdatedTimestamp: type: string format: date-time taskDueDate: type: string format: date taskPriority: type: string taskType: type: string timestamp: type: string format: date-time title: type: string unresolvedEncounterId: type: string validated: type: string ward: type: string CareService.CdmTeam: type: object properties: cancerSites: type: array nullable: true items: type: string careServiceId: type: string createdAt: type: string format: date-time createdBy: type: string description: type: string locationIds: type: array nullable: true items: type: string modules: type: array nullable: true items: type: string name: type: string siteIds: type: array nullable: true items: type: string siteNames: type: array nullable: true items: type: string specialties: type: array nullable: true items: type: string status: type: string teamId: type: string teamTypes: type: array nullable: true items: type: string updatedAt: type: string format: date-time updatedBy: type: string CareService.TransferOfCareRequest: type: object properties: destinationCareServiceId: type: string requestAcceptedDate: type: string format: date requestCreatedDate: type: string format: date requestReceivedDate: type: string format: date requestedByCareServiceId: type: string resultingAdmissionId: type: string sourceAdmissionId: type: string status: type: string transferCompletedDate: type: string format: date transferOfCareRequestId: type: string transferReason: type: string updatedAt: type: string format: date-time updatedBy: type: string CdmModulePermissioning.LogEditCdmModulePermissioning: type: object properties: actionRid: type: string actionSummary: type: string actionTimestamp: type: string format: date-time actionTriggererUserId: type: string actionTypeRid: type: string actionTypeVersion: type: string cdmModulePermissioning: type: array nullable: true items: type: string cdmModulePermissioningModuleGroupIds_5: type: array nullable: true items: type: string cdmModulePermissioningModuleName_5: type: string isReverted: type: boolean moduleGroupIds_3: type: array nullable: true items: type: string newParameter_5: type: string revertTimestamp: type: string format: date-time revertUser: type: string CdmObjectPermissioning.LogUpdateOptionalGroupIdsForObjectPermissioning: type: object properties: actionRid: type: string actionSummary: type: string actionTimestamp: type: string format: date-time actionTriggererUserId: type: string actionTypeRid: type: string actionTypeVersion: type: string cdmObjectPermissioning: type: array nullable: true items: type: string cdmObjectPermissioningModules_6: type: array nullable: true items: type: string cdmObjectPermissioningObjectGroupIds_6: type: array nullable: true items: type: string cdmObjectPermissioningObjectId_6: type: string cdmObjectPermissioningObjectName_6: type: string isReverted: type: boolean newParameter_6: type: string objectGroupIds_5: type: array nullable: true items: type: string revertTimestamp: type: string format: date-time revertUser: type: string CdmPathwayComment.PatientPathway: type: object properties: _104WeeksBreachDate: type: string format: date _18WeeksBreachDate: type: string format: date _52WeeksBreachDate: type: string format: date _65WeeksBreachDate: type: string format: date _78WeeksBreachDate: type: string format: date accessibilityFlags: type: array nullable: true items: type: string admissionMethodCode: type: string age: type: string format: long closureReason: type: string consultantId: type: string consultantName: type: string covidPriority: type: string covidPriorityDate: type: string format: date dataSource: type: string dateOfBirth: type: string format: date daysTo104WeekBreachDate: type: integer daysTo18WeekBreachDate: type: integer daysTo52WeekBreachDate: type: integer daysTo65WeekBreachDate: type: integer daysTo78WeekBreachDate: type: integer derivedPathwayType: type: string directorate: type: string division: type: string dtaDate: type: string format: date intendedProcedureDescription: type: string isActiveRttPathway: type: boolean isOpenPathway: type: boolean 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 latestEpisodeId: type: string latestPathwayStatusCodeNational: type: string latestPathwayStatusDescriptionNational: type: string latestPeriodEndDate: type: string format: date latestPeriodEndReason: type: string latestPeriodLengthDays: type: integer latestPeriodLengthWeeks: type: integer latestPeriodStartDate: type: string format: date latestPeriodStartReason: type: string latestProcedurePriorityCode: type: string latestReferralReceivedDate: type: string format: date latestRttPeriodId: type: string 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 originalReferralSpecialtyId: type: string originalReferralSpecialtyName: type: string owlClinicCode: type: string owlFlag: type: boolean owlGroupCode: type: string pathwayClass: type: string pathwayEndDate: type: string format: date pathwayId: type: string pathwayStage: type: string pathwayStartDate: type: string format: date pathwayStatus: type: string pathwaySubtype: type: string pathwayType: type: string patientDeceased: type: boolean patientId: type: string patientName: type: string ppid: type: string ppidIssuer: type: string ppidIssuerOdsCode: type: string prospectiveRttPeriodEndDate: type: string format: date prospectiveRttWeeksWait: type: integer referralDate: type: string format: date referralId: type: string referralPriority: type: string referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true 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 waitingTimeMeasurementType: type: string waitingTimeMeasurementTypeCode: type: string waitingTimeMeasurementTypeCodeLocalCode: type: string weeksTo104WeekBreachDate: type: integer weeksTo18WeekBreachDate: type: integer weeksTo52WeekBreachDate: type: integer weeksTo65WeekBreachDate: type: integer weeksTo78WeekBreachDate: type: integer weeksWaitSinceDtaDate: type: integer weeksWaitSinceLastPatientContact: type: integer weeksWaitToProspectiveRttPeriodEndDate: type: integer weeksWaitToTciDate: type: integer CdmTeam.CareService: type: object properties: careServiceId: type: string createdAt: type: string format: date-time createdBy: type: string description: type: string modules: type: array nullable: true items: type: string name: type: string status: type: string updatedAt: type: string format: date-time updatedBy: type: string CdmTeam.CdmTeamMember: type: object properties: band: type: string createdAt: type: string format: date-time createdBy: type: string jobTitle: type: string updatedAt: type: string format: date-time updatedBy: type: string userId: type: string CdmTeam.CdmTeamMembership: type: object properties: createdAt: type: string format: date-time createdBy: type: string roles: type: array nullable: true items: type: string teamId: type: string teamMembershipId: type: string updatedAt: type: string format: date-time updatedBy: type: string userId: type: string CdmTeam.Site: type: object properties: id: type: string name: type: string rvGroupIds: type: array nullable: true items: type: string siteOdsCode: type: string CdmTeam.Specialty: type: object properties: isActiveSpecialty: type: boolean rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string theatreSpecialty: type: boolean CdmTeamMember.CdmTeam: type: object properties: cancerSites: type: array nullable: true items: type: string careServiceId: type: string createdAt: type: string format: date-time createdBy: type: string description: type: string locationIds: type: array nullable: true items: type: string modules: type: array nullable: true items: type: string name: type: string siteIds: type: array nullable: true items: type: string siteNames: type: array nullable: true items: type: string specialties: type: array nullable: true items: type: string status: type: string teamId: type: string teamTypes: type: array nullable: true items: type: string updatedAt: type: string format: date-time updatedBy: type: string CdmTeamMember.CdmTeamMembership: type: object properties: createdAt: type: string format: date-time createdBy: type: string roles: type: array nullable: true items: type: string teamId: type: string teamMembershipId: type: string updatedAt: type: string format: date-time updatedBy: type: string userId: type: string CdmTeamMembership.CdmTeam: type: object properties: cancerSites: type: array nullable: true items: type: string careServiceId: type: string createdAt: type: string format: date-time createdBy: type: string description: type: string locationIds: type: array nullable: true items: type: string modules: type: array nullable: true items: type: string name: type: string siteIds: type: array nullable: true items: type: string siteNames: type: array nullable: true items: type: string specialties: type: array nullable: true items: type: string status: type: string teamId: type: string teamTypes: type: array nullable: true items: type: string updatedAt: type: string format: date-time updatedBy: type: string CdmTeamMembership.CdmTeamMember: type: object properties: band: type: string createdAt: type: string format: date-time createdBy: type: string jobTitle: type: string updatedAt: type: string format: date-time updatedBy: type: string userId: type: string ChangeLogRequest.Encounter: type: object properties: administrativeCategoryCode: type: string administrativeCategoryDescription: type: string admissionMethod: type: string admissionOfferTimestamp: type: string format: date-time admissionStatus: type: string admissionSubStatus: type: string admissionType: type: string atsTotalTheatreTime: type: integer calculatedTotalTheatreTime: type: integer cancerPriorityOrdering: type: integer createdBy: type: string createdDate: type: string format: date criticalCareBedStatus: type: string division: type: string ealId: type: string encounterFreeText: type: string encounterId: type: string encounterType: type: string estimatedTotalTheatreTime: type: integer externalId: type: string genericWaitlistEntryId: type: string hasDateInTheLastNDays: type: boolean 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 isAdmissionOfferTimestampInTheLastNDays: type: boolean isBooked: type: boolean isMetricEncounter: type: boolean isSuitableForPooledList: type: boolean isSurgicalOrderDateInTheLastNDays: type: boolean isTciDateInTheLastNDays: type: boolean issues: type: array nullable: true items: type: string lastCovidSwabBookingStatus: type: string lastCovidSwabOutcome: type: string lastMrsaSwabBookingStatus: type: string lastMrsaSwabOutcome: type: string lastPoaBookingStatus: type: string lastPoaExpiryDate: type: string format: date lastPoaOutcome: type: string lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string lastPoaScheduledOrAttendedDatetime: type: string format: date-time lastRefreshedAtSourceTimestamp: 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 periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string site: type: string siteId: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string surgicalOrderDate: type: string format: date 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 ChangeLogRequest.ValidatedChangelog: type: object properties: actionType: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserGroup: type: string assignedUserIds: type: array nullable: true items: type: string careProfessionalId: type: string careProfessionalName: type: string changeLogId: type: string closedAt: type: string format: date-time closedBy: type: string commentUser: type: string comments: type: string daysOpen: type: integer description: type: string ealId: type: string encounterId: type: string externalId: type: string freeTextComments: type: string isRtt: type: boolean lastRefreshed: type: string format: date-time mrn: type: string newValue: type: string originatingWaitingListAlertRuleTypes: type: array nullable: true items: type: string originatingWaitingListAlertUniqueIds: type: array nullable: true items: type: string patientId: type: string patientName: type: string preResolved: type: boolean primaryConsultantId: type: string primaryConsultantName: type: string primaryEvidenceSource: type: string priority: type: string propertyToModify: type: string rcsClinicalHarmReview: type: string removalDate: type: string format: date removed: type: boolean requestedBy: type: string requiredAction: type: string resolved: type: boolean secondaryEvidenceSource: type: array nullable: true items: type: string siteId: type: string specialtyId: type: string specialtyName: type: string status: type: string statusUpdatedByUser: type: string statusUpdatedTimestamp: type: string format: date-time taskDueDate: type: string format: date taskPriority: type: string taskType: type: string timestamp: type: string format: date-time title: type: string unresolvedEncounterId: type: string validated: type: string ward: type: string ClinicLetter.Appointment: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string appointmentBookedReason: type: string appointmentBookedReasonCode: type: string appointmentBookedReasonLocalCode: type: string appointmentFreeText: type: string attendanceId: type: string attendanceStatus: type: string attendanceStatusCode: type: string attendanceStatusLocalCode: type: string bookedBy: type: string bookedDuration: type: integer bookingStatus: type: string cancellationReason: type: string cancelledBy: type: string cancerPriorityOrdering: type: integer category: type: string clinicId: type: string code: type: string consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string dateTimeBooked: type: string format: date-time dateTimeCancelled: type: string format: date-time earliestClinicallyAppropriateDate: type: string format: date earliestReasonableOfferDate: type: string format: date endDateTime: type: string format: date-time hasDateInTheLastNDays: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string isDateTimeBookedInTheLastNDays: type: boolean isDateTimeCancelledInTheLastNDays: type: boolean isFirstAppointment: type: boolean isOrderedDateInTheLastNDays: type: boolean isPoaAppointment: type: boolean isStartDateTimeInTheLastNDays: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time latestClinicallyAppropriateDate: type: string format: date orderedDate: type: string format: date outcomeOfAttendance: type: string outcomeOfAttendanceCode: type: string outcomeOfAttendanceLocalCode: type: string pathwayId: type: string 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 nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string startDateTime: type: string format: date-time treatmentFunctionCode: type: string treatmentFunctionLocalCode: type: string treatmentFunctionName: type: string type: type: string wasPatientOnPifuPathway: type: boolean wasPatientSubjectToRemoteMontitoring: type: boolean ClinicLetter.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string ClinicSession.Appointment: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string appointmentBookedReason: type: string appointmentBookedReasonCode: type: string appointmentBookedReasonLocalCode: type: string appointmentFreeText: type: string attendanceId: type: string attendanceStatus: type: string attendanceStatusCode: type: string attendanceStatusLocalCode: type: string bookedBy: type: string bookedDuration: type: integer bookingStatus: type: string cancellationReason: type: string cancelledBy: type: string cancerPriorityOrdering: type: integer category: type: string clinicId: type: string code: type: string consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string dateTimeBooked: type: string format: date-time dateTimeCancelled: type: string format: date-time earliestClinicallyAppropriateDate: type: string format: date earliestReasonableOfferDate: type: string format: date endDateTime: type: string format: date-time hasDateInTheLastNDays: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string isDateTimeBookedInTheLastNDays: type: boolean isDateTimeCancelledInTheLastNDays: type: boolean isFirstAppointment: type: boolean isOrderedDateInTheLastNDays: type: boolean isPoaAppointment: type: boolean isStartDateTimeInTheLastNDays: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time latestClinicallyAppropriateDate: type: string format: date orderedDate: type: string format: date outcomeOfAttendance: type: string outcomeOfAttendanceCode: type: string outcomeOfAttendanceLocalCode: type: string pathwayId: type: string 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 nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string startDateTime: type: string format: date-time treatmentFunctionCode: type: string treatmentFunctionLocalCode: type: string treatmentFunctionName: type: string type: type: string wasPatientOnPifuPathway: type: boolean wasPatientSubjectToRemoteMontitoring: type: boolean ClinicSession.CareProfessional: type: object properties: careProfessionalId: type: string careProfessionalLocalId: type: string isActive: type: boolean localSubSpecialties: type: array nullable: true items: type: string mainSpecialty: type: string mainSpecialtyCode: type: string name: type: string professionalRegistrationBody: type: string professionalRegistrationBodyCode: type: string professionalRegistrationEntryId: type: string role: type: string rvGroupIds: type: array nullable: true items: type: string ClinicSession.ClinicSlot: 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 nullable: true items: type: string serviceIds: type: array nullable: true 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 ClinicSession.ClinicType: type: object properties: clinicTypeActive: type: boolean clinicTypeId: type: string clinicTypeName: type: string rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string ClinicSlot.ClinicSession: type: object properties: amPm: type: string bookingTeam: type: string cancellationReason: type: string cancellationTimestamp: type: string format: date-time careProfessionalId: type: string clinicCode: type: string clinicDisplayName: type: string clinicEndTimestamp: type: string format: date-time clinicFreeText: type: string clinicId: type: string clinicModality: type: string clinicName: type: string clinicStartTimestamp: type: string format: date-time clinicTypeActive: type: boolean clinicTypeId: type: string clinicTypeName: type: string clinicUtilisation: type: number format: double clinicUtilisationRag: type: string date: type: string format: date hasAnnualLeave: type: boolean hasAnnualLeaveString: type: string isCancelled: type: boolean isPrivate: type: boolean leadConsultant: type: string leadConsultantId: type: string location: type: string overbooked: type: boolean roomId: type: string rvGroupIds: type: array nullable: true items: type: string siteId: type: string siteName: type: string slotSpecialtyIds: type: array nullable: true items: type: string slotUtilisationPercentage: type: number format: double slotUtilisationRag: type: string specialtyId: type: string specialtyName: 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 nullable: true items: type: string treatmentFunctionNames: type: array nullable: true items: type: string type: type: string weekDelta: type: integer weekDeltaString: type: string weekDeltaStringDetails: type: string ClinicSlot.ErsService: type: object properties: active: type: boolean referralReason: type: string rvGroupIds: type: array nullable: true items: type: string serviceDirectoryId: type: string serviceName: type: string serviceType: type: string siteId: type: string specialtyIds: type: array nullable: true items: type: string uniqueId: type: string ClinicType.ClinicSession: type: object properties: amPm: type: string bookingTeam: type: string cancellationReason: type: string cancellationTimestamp: type: string format: date-time careProfessionalId: type: string clinicCode: type: string clinicDisplayName: type: string clinicEndTimestamp: type: string format: date-time clinicFreeText: type: string clinicId: type: string clinicModality: type: string clinicName: type: string clinicStartTimestamp: type: string format: date-time clinicTypeActive: type: boolean clinicTypeId: type: string clinicTypeName: type: string clinicUtilisation: type: number format: double clinicUtilisationRag: type: string date: type: string format: date hasAnnualLeave: type: boolean hasAnnualLeaveString: type: string isCancelled: type: boolean isPrivate: type: boolean leadConsultant: type: string leadConsultantId: type: string location: type: string overbooked: type: boolean roomId: type: string rvGroupIds: type: array nullable: true items: type: string siteId: type: string siteName: type: string slotSpecialtyIds: type: array nullable: true items: type: string slotUtilisationPercentage: type: number format: double slotUtilisationRag: type: string specialtyId: type: string specialtyName: 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 nullable: true items: type: string treatmentFunctionNames: type: array nullable: true items: type: string type: type: string weekDelta: type: integer weekDeltaString: type: string weekDeltaStringDetails: type: string ClinicType.ErsService: type: object properties: active: type: boolean referralReason: type: string rvGroupIds: type: array nullable: true items: type: string serviceDirectoryId: type: string serviceName: type: string serviceType: type: string siteId: type: string specialtyIds: type: array nullable: true items: type: string uniqueId: type: string ClinicType.Specialty: type: object properties: isActiveSpecialty: type: boolean rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string theatreSpecialty: type: boolean Comorbidity.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string ConsultantEpisode.Admission: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string admissionExternalId: type: string admissionId: type: string admissionMethod: type: string admissionSource: type: string admissionSourceCode: type: string admissionSourceLocalCode: type: string admissionStatus: type: string admissionTimestamp: type: string format: date-time admissionTitle: type: string admissionType: type: string bedLocation: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string destinationOfDischargeLocalCode: type: string dischargeDestinationType: type: string dischargePathway: type: string dischargeReadyDate: type: string format: date dischargeTimestamp: type: string format: date-time ealEntryId: type: string encounterId: type: string estimatedDischargeDate: type: string format: date-time isDischargeTimeConfirmed: type: boolean localAuthority: type: string methodOfAdmission: type: string methodOfAdmissionCode: type: string methodOfAdmissionLocalCode: type: string methodOfDischarge: type: string methodOfDischargeCode: type: string methodOfDischargeLocalCode: type: string pathwayId: type: string patientClassification: type: string patientClassificationCode: type: string patientClassificationLocalCode: type: string patientId: type: string patientName: type: string rvGroupIds: type: array nullable: true items: type: string siteName: type: string specialtyId: type: string specialtyName: type: string startTimestamp: type: string format: date-time treatmentFunctionCode: type: string ward: type: string wasPatientDischargedToNhsAtHomeService: type: boolean ConsultantEpisode.AssignedCareProfessional: type: object properties: appointmentId: type: string assignedCareProfessionalId: type: string careProfessionalId: type: string clinicalResponsibilityTimestamp: type: string format: date-time consultantEpisodeId: type: string isResponsibleCareProfessional: type: boolean isResponsibleForEdDischarge: type: boolean rvGroupIds: type: array nullable: true items: type: string uecAttendanceId: type: string ConsultantEpisode.HomeLeave: type: object properties: admissionId: type: string consultantEpisodeId: type: string endTimestamp: type: string format: date-time homeLeaveId: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time ConsultantEpisode.Labour: type: object properties: actualDeliveryPlace: type: string actualDeliveryPlaceCode: type: string actualDeliveryPlaceLocalCode: type: string admissionId: type: string anaestheticGivenDuringLabourOrDelivery: type: string anaestheticGivenDuringLabourOrDeliveryCode: type: string anaestheticGivenDuringLabourOrDeliveryLocalCode: type: string anaestheticGivenPostLabourOrDelivery: type: string anaestheticGivenPostLabourOrDeliveryCode: type: string anaestheticGivenPostLabourOrDeliveryLocalCode: type: string consultantEpisodeId: type: string deliveryPlaceChangeReason: type: string deliveryPlaceChangeReasonCode: type: string deliveryPlaceChangeReasonLocalCode: type: string labourId: type: string labourOrDeliveryOnsetMethod: type: string labourOrDeliveryOnsetMethodCode: type: string labourOrDeliveryOnsetMethodLocalCode: type: string pregnancyId: type: string rvGroupIds: type: array nullable: true items: type: string ConsultantEpisode.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string ConsultantEpisode.PatientDiagnosis: type: object properties: active: type: string admissionId: type: string consultantEpisodeId: type: string diagnosisEndDate: type: string format: date diagnosisIcd10Code: type: string diagnosisId: type: string diagnosisName: type: string diagnosisSnomedCtCode: type: string diagnosisStartDate: type: string format: date diagnosisTimestamp: type: string format: date-time encounterId: type: string isPrimaryDiagnosis: type: boolean patientId: type: string patientPathwayId: type: string rvGroupIds: type: array nullable: true items: type: string uecAttendanceId: type: string virtualWardStayId: type: string ConsultantEpisode.Procedure: type: object properties: actualProcedureTimeKnifeToSkinClosure: type: integer actualProcedureTimeTotalTheatreTime: type: integer admissionId: type: string admissionMethodDescription: type: string anaestheticTypeToBeUsed: type: string anaesthetistRequired: type: boolean appointmentId: type: string consultantEpisodeId: type: string 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 procedure: type: string procedureDate: type: string format: date procedureId: type: string procedureOpcsCode: type: string procedureOrdered: type: integer procedureSnomedCtCode: type: string procedureTimeOrOrder: type: string procedureTimestamp: type: string format: date-time responsibleAnaesthetistCareProfessionalId: type: string rvGroupIds: type: array nullable: true items: type: string theatreSessionId: type: string title: type: string uecAttendanceId: type: string virtualWardStayId: type: string ConsultantEpisode.ScoredAssessment: type: object properties: admissionId: type: string appointmentId: type: string assessmentToolType: type: string assessmentToolTypeSnomedCtCode: type: string completionTimestamp: type: string format: date-time consultantEpisodeId: type: string patientId: type: string personScore: type: string rvGroupIds: type: array nullable: true items: type: string scoredAssessmentId: type: string uecAttendanceId: type: string virtualWardStayId: type: string Core.Distance: required: - unit - value type: object properties: unit: $ref: "#/components/schemas/Core.DistanceUnit" value: type: number format: double example: 10.0 description: A measurement of distance. Core.DistanceUnit: type: string enum: - MILLIMETERS - CENTIMETERS - METERS - KILOMETERS - INCHES - FEET - YARDS - MILES - NAUTICAL_MILES Core.MediaReference: required: - mimeType - reference type: object properties: mimeType: type: string reference: $ref: "#/components/schemas/Core.Reference" description: The representation of a media reference. Core.MediaSetViewItem: required: - mediaItemRid - mediaSetRid - mediaSetViewRid type: object properties: mediaItemRid: type: string mediaSetRid: type: string mediaSetViewRid: type: string token: type: string Core.MediaSetViewItemWrapper: required: - mediaSetViewItem - type type: object properties: mediaSetViewItem: $ref: "#/components/schemas/Core.MediaSetViewItem" type: type: string Core.Reference: description: | A union of the types supported by media reference properties. discriminator: propertyName: type mapping: mediaSetViewItem: "#/components/schemas/Core.MediaSetViewItemWrapper" oneOf: - $ref: "#/components/schemas/Core.MediaSetViewItemWrapper" CriticalCareDailySummary.CriticalCarePeriod: type: object properties: admissionId: type: string criticalCareAdmissionSource: type: string criticalCareAdmissionSourceCode: type: string criticalCareAdmissionSourceLocalCode: type: string criticalCareAdmissionType: type: string criticalCareAdmissionTypeCode: type: string criticalCareAdmissionTypeLocalCode: type: string criticalCareDischargeDestination: type: string criticalCareDischargeDestinationCode: type: string criticalCareDischargeDestinationLocalCode: type: string criticalCareDischargeLocation: type: string criticalCareDischargeLocationCode: type: string criticalCareDischargeLocationLocalCode: type: string criticalCareDischargeStatus: type: string criticalCareDischargeStatusCode: type: string criticalCareDischargeStatusLocalCode: type: string criticalCarePeriodId: type: string criticalCarePeriodType: type: string criticalCareSourceLocation: type: string criticalCareSourceLocationCode: type: string criticalCareSourceLocationLocalCode: type: string criticalCareUnitFunction: type: string criticalCareUnitFunctionCode: type: string criticalCareUnitFunctionLocalCode: type: string dischargeTimestamp: type: string format: date-time maxNumberOfOrganSystemsSupportedOnOneDay: type: integer patientId: type: string readyForDischargeTimestamp: type: string format: date-time rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time totalNumberOfAdvancedCardiovascularSupportDays: type: integer totalNumberOfAdvancedRespiratorySupportDays: type: integer totalNumberOfBasicCardiovascularSupportDays: type: integer totalNumberOfBasicRespiratorySupportDays: type: integer totalNumberOfDermatologicalSupportDays: type: integer totalNumberOfGastrointestinalSupportDays: type: integer totalNumberOfLevel2CareDays: type: integer totalNumberOfLevel3CareDays: type: integer totalNumberOfLiverSupportDays: type: integer totalNumberOfNeurologicalSupportDays: type: integer totalNumberOfRenalSupportDays: type: integer unitBedConfiguration: type: string unitBedConfigurationCode: type: string unitBedConfigurationLocalCode: type: string CriticalCarePeriod.Admission: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string admissionExternalId: type: string admissionId: type: string admissionMethod: type: string admissionSource: type: string admissionSourceCode: type: string admissionSourceLocalCode: type: string admissionStatus: type: string admissionTimestamp: type: string format: date-time admissionTitle: type: string admissionType: type: string bedLocation: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string destinationOfDischargeLocalCode: type: string dischargeDestinationType: type: string dischargePathway: type: string dischargeReadyDate: type: string format: date dischargeTimestamp: type: string format: date-time ealEntryId: type: string encounterId: type: string estimatedDischargeDate: type: string format: date-time isDischargeTimeConfirmed: type: boolean localAuthority: type: string methodOfAdmission: type: string methodOfAdmissionCode: type: string methodOfAdmissionLocalCode: type: string methodOfDischarge: type: string methodOfDischargeCode: type: string methodOfDischargeLocalCode: type: string pathwayId: type: string patientClassification: type: string patientClassificationCode: type: string patientClassificationLocalCode: type: string patientId: type: string patientName: type: string rvGroupIds: type: array nullable: true items: type: string siteName: type: string specialtyId: type: string specialtyName: type: string startTimestamp: type: string format: date-time treatmentFunctionCode: type: string ward: type: string wasPatientDischargedToNhsAtHomeService: type: boolean CriticalCarePeriod.CriticalCareDailySummary: type: object properties: criticalCareActivities: type: array nullable: true items: type: string criticalCareActivityCodes: type: array nullable: true items: type: string criticalCareActivityLocalCodes: type: array nullable: true items: type: string criticalCareDailySummaryDate: type: string format: date criticalCareDailySummaryId: type: string criticalCareLevel: type: string criticalCareLevelCode: type: string criticalCareLevelLocalCode: type: string criticalCarePeriodId: type: string highCostDrugOpcs4Codes: type: array nullable: true items: type: string highCostDrugs: type: array nullable: true items: type: string organSystemsSupported: type: array nullable: true items: type: string organSystemsSupportedCodes: type: array nullable: true items: type: string organSystemsSupportedLocalCodes: type: array nullable: true items: type: string patientWeightKg: type: number format: double rvGroupIds: type: array nullable: true items: type: string CriticalCarePeriod.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string DiagnosticsWaitlistEntry.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string DiagnosticsWaitlistEntry.PatientPathway: type: object properties: _104WeeksBreachDate: type: string format: date _18WeeksBreachDate: type: string format: date _52WeeksBreachDate: type: string format: date _65WeeksBreachDate: type: string format: date _78WeeksBreachDate: type: string format: date accessibilityFlags: type: array nullable: true items: type: string admissionMethodCode: type: string age: type: string format: long closureReason: type: string consultantId: type: string consultantName: type: string covidPriority: type: string covidPriorityDate: type: string format: date dataSource: type: string dateOfBirth: type: string format: date daysTo104WeekBreachDate: type: integer daysTo18WeekBreachDate: type: integer daysTo52WeekBreachDate: type: integer daysTo65WeekBreachDate: type: integer daysTo78WeekBreachDate: type: integer derivedPathwayType: type: string directorate: type: string division: type: string dtaDate: type: string format: date intendedProcedureDescription: type: string isActiveRttPathway: type: boolean isOpenPathway: type: boolean 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 latestEpisodeId: type: string latestPathwayStatusCodeNational: type: string latestPathwayStatusDescriptionNational: type: string latestPeriodEndDate: type: string format: date latestPeriodEndReason: type: string latestPeriodLengthDays: type: integer latestPeriodLengthWeeks: type: integer latestPeriodStartDate: type: string format: date latestPeriodStartReason: type: string latestProcedurePriorityCode: type: string latestReferralReceivedDate: type: string format: date latestRttPeriodId: type: string 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 originalReferralSpecialtyId: type: string originalReferralSpecialtyName: type: string owlClinicCode: type: string owlFlag: type: boolean owlGroupCode: type: string pathwayClass: type: string pathwayEndDate: type: string format: date pathwayId: type: string pathwayStage: type: string pathwayStartDate: type: string format: date pathwayStatus: type: string pathwaySubtype: type: string pathwayType: type: string patientDeceased: type: boolean patientId: type: string patientName: type: string ppid: type: string ppidIssuer: type: string ppidIssuerOdsCode: type: string prospectiveRttPeriodEndDate: type: string format: date prospectiveRttWeeksWait: type: integer referralDate: type: string format: date referralId: type: string referralPriority: type: string referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true 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 waitingTimeMeasurementType: type: string waitingTimeMeasurementTypeCode: type: string waitingTimeMeasurementTypeCodeLocalCode: type: string weeksTo104WeekBreachDate: type: integer weeksTo18WeekBreachDate: type: integer weeksTo52WeekBreachDate: type: integer weeksTo65WeekBreachDate: type: integer weeksTo78WeekBreachDate: type: integer weeksWaitSinceDtaDate: type: integer weeksWaitSinceLastPatientContact: type: integer weeksWaitToProspectiveRttPeriodEndDate: type: integer weeksWaitToTciDate: type: integer DiagnosticsWaitlistEntry.Specialty: type: object properties: isActiveSpecialty: type: boolean rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string theatreSpecialty: type: boolean EMed3FitNote.Admission: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string admissionExternalId: type: string admissionId: type: string admissionMethod: type: string admissionSource: type: string admissionSourceCode: type: string admissionSourceLocalCode: type: string admissionStatus: type: string admissionTimestamp: type: string format: date-time admissionTitle: type: string admissionType: type: string bedLocation: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string destinationOfDischargeLocalCode: type: string dischargeDestinationType: type: string dischargePathway: type: string dischargeReadyDate: type: string format: date dischargeTimestamp: type: string format: date-time ealEntryId: type: string encounterId: type: string estimatedDischargeDate: type: string format: date-time isDischargeTimeConfirmed: type: boolean localAuthority: type: string methodOfAdmission: type: string methodOfAdmissionCode: type: string methodOfAdmissionLocalCode: type: string methodOfDischarge: type: string methodOfDischargeCode: type: string methodOfDischargeLocalCode: type: string pathwayId: type: string patientClassification: type: string patientClassificationCode: type: string patientClassificationLocalCode: type: string patientId: type: string patientName: type: string rvGroupIds: type: array nullable: true items: type: string siteName: type: string specialtyId: type: string specialtyName: type: string startTimestamp: type: string format: date-time treatmentFunctionCode: type: string ward: type: string wasPatientDischargedToNhsAtHomeService: type: boolean EMed3FitNote.Appointment: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string appointmentBookedReason: type: string appointmentBookedReasonCode: type: string appointmentBookedReasonLocalCode: type: string appointmentFreeText: type: string attendanceId: type: string attendanceStatus: type: string attendanceStatusCode: type: string attendanceStatusLocalCode: type: string bookedBy: type: string bookedDuration: type: integer bookingStatus: type: string cancellationReason: type: string cancelledBy: type: string cancerPriorityOrdering: type: integer category: type: string clinicId: type: string code: type: string consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string dateTimeBooked: type: string format: date-time dateTimeCancelled: type: string format: date-time earliestClinicallyAppropriateDate: type: string format: date earliestReasonableOfferDate: type: string format: date endDateTime: type: string format: date-time hasDateInTheLastNDays: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string isDateTimeBookedInTheLastNDays: type: boolean isDateTimeCancelledInTheLastNDays: type: boolean isFirstAppointment: type: boolean isOrderedDateInTheLastNDays: type: boolean isPoaAppointment: type: boolean isStartDateTimeInTheLastNDays: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time latestClinicallyAppropriateDate: type: string format: date orderedDate: type: string format: date outcomeOfAttendance: type: string outcomeOfAttendanceCode: type: string outcomeOfAttendanceLocalCode: type: string pathwayId: type: string 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 nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string startDateTime: type: string format: date-time treatmentFunctionCode: type: string treatmentFunctionLocalCode: type: string treatmentFunctionName: type: string type: type: string wasPatientOnPifuPathway: type: boolean wasPatientSubjectToRemoteMontitoring: type: boolean EMed3FitNote.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string EMed3FitNote.UecAttendance: type: object properties: acuity: type: string acuitySnomedCtCode: type: string admissionId: type: string ambulanceCallId: type: string ambulanceIncidentId: type: string arrivalMode: type: string arrivalModeSnomedCtCode: type: string arrivalTimestamp: type: string format: date-time attendanceSource: type: string attendanceSourceSite: type: string attendanceSourceSiteOdsCode: type: string attendanceSourceSnomedCtCode: type: string chiefComplaint: type: string chiefComplaintSnomedCtCode: type: string clinicallyReadyToProceedTimestamp: type: string format: date-time consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string conveyingAmbulanceTrust: type: string conveyingAmbulanceTrustOdsCode: type: string decisionToAdmitTimestamp: type: string format: date-time departureTimestamp: type: string format: date-time dischargeDestination: type: string dischargeDestinationSnomedCtCode: type: string dischargeFollowUp: type: string dischargeFollowUpSnomedCtCode: type: string dischargeSite: type: string dischargeSiteOdsCode: type: string dischargeStatus: type: string dischargeStatusSnomedCtCode: type: string edExtendedCareEpisodeId: type: string emergencyCareDepartmentType: type: string emergencyCareDepartmentTypeCode: type: string emergencyCareDepartmentTypeLocalCode: type: string expectedTreatmentAllocationTimestamp: type: string format: date-time expectedTreatmentTimestamp: type: string format: date-time hasDischargeInformationBeenGiven: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string initialAssessmentTimestamp: type: string format: date-time patientId: type: string rvGroupIds: type: array nullable: true items: type: string safeguardingConcerns: type: array nullable: true items: type: string safeguardingConcernsSnomedCtCodes: type: array nullable: true items: type: string seenForTreatmentTimestamp: type: string format: date-time treatmentSite: type: string treatmentSiteOdsCode: type: string uecAttendanceExternalId: type: string uecAttendanceId: type: string urgentAndEmergencyCareAttendanceCategory: type: string urgentAndEmergencyCareAttendanceCategoryCode: type: string urgentAndEmergencyCareAttendanceCategoryLocalCode: type: string EalEntry.Encounter: type: object properties: administrativeCategoryCode: type: string administrativeCategoryDescription: type: string admissionMethod: type: string admissionOfferTimestamp: type: string format: date-time admissionStatus: type: string admissionSubStatus: type: string admissionType: type: string atsTotalTheatreTime: type: integer calculatedTotalTheatreTime: type: integer cancerPriorityOrdering: type: integer createdBy: type: string createdDate: type: string format: date criticalCareBedStatus: type: string division: type: string ealId: type: string encounterFreeText: type: string encounterId: type: string encounterType: type: string estimatedTotalTheatreTime: type: integer externalId: type: string genericWaitlistEntryId: type: string hasDateInTheLastNDays: type: boolean 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 isAdmissionOfferTimestampInTheLastNDays: type: boolean isBooked: type: boolean isMetricEncounter: type: boolean isSuitableForPooledList: type: boolean isSurgicalOrderDateInTheLastNDays: type: boolean isTciDateInTheLastNDays: type: boolean issues: type: array nullable: true items: type: string lastCovidSwabBookingStatus: type: string lastCovidSwabOutcome: type: string lastMrsaSwabBookingStatus: type: string lastMrsaSwabOutcome: type: string lastPoaBookingStatus: type: string lastPoaExpiryDate: type: string format: date lastPoaOutcome: type: string lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string lastPoaScheduledOrAttendedDatetime: type: string format: date-time lastRefreshedAtSourceTimestamp: 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 periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string site: type: string siteId: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string surgicalOrderDate: type: string format: date 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 EalEntry.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string EalEntry.TheatreBooking: 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 lastPoaExpiryDate: type: string format: date lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string mrn: type: string patientId: type: string periOpRiskStratificationOutcome: type: string periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string status: type: string statusRender: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreSessionDate: type: string format: date theatreSessionId: type: string Encounter.BookingRequest: type: object properties: action: type: string amPm: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserGroup: type: string assignedUserIds: type: array nullable: true items: type: string bookingRequestId: type: string closedAt: type: string format: date-time closedBy: type: string comment: type: string consultantId: type: string date: type: string format: date encounterEstimatedTotalTheatreTime: type: integer encounterId: type: string intendedPrimaryProcedureDescription: type: string intendedPrimaryProcedureFreeText: type: string mnemonic: type: string mrn: type: string personId: type: string reason: type: string specialtyId: type: string status: type: string taskDueDate: type: string format: date taskPriority: type: string taskType: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreName: type: string theatreSessionId: type: string theatreSessionPlannedDurationMinutes: type: integer theatreSessionPrimaryConsultantId: type: string timestamp: type: string format: date-time title: type: string type: type: string updatedAt: type: string format: date-time updatedBy: type: string userId: type: string Encounter.CareProfessional: type: object properties: careProfessionalId: type: string careProfessionalLocalId: type: string isActive: type: boolean localSubSpecialties: type: array nullable: true items: type: string mainSpecialty: type: string mainSpecialtyCode: type: string name: type: string professionalRegistrationBody: type: string professionalRegistrationBodyCode: type: string professionalRegistrationEntryId: type: string role: type: string rvGroupIds: type: array nullable: true items: type: string Encounter.ChangeLogRequest: type: object properties: actionType: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserIds: type: array nullable: true items: type: string careProfessionalId: type: string careProfessionalName: type: string changeLogId: type: string closedAt: type: string format: date-time closedBy: type: string description: type: string ealId: type: string encounterId: type: string freeTextComments: type: string isRTT: type: boolean newValue: type: string originatingWaitingListAlertRuleIds: type: array nullable: true items: type: string originatingWaitingListAlertRuleTypes: type: array nullable: true items: type: string preResolved: type: boolean primaryEvidenceSource: type: string propertyToModify: type: string rcsClinicalHarmReview: type: string requestedBy: type: string resolved: type: boolean secondaryEvidenceSource: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string taskDueDate: type: string format: date taskPriority: type: string taskType: type: string timestamp: type: string format: date-time Encounter.EalEntry: 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 earliestClinicallyAppropriateDate: type: string format: date earliestReasonableOfferDate: type: string format: date episodeId: type: string hasRttPathwayDescription: type: string intendedManagement: type: string intendedManagementCode: type: string intendedManagementLocalCode: type: string isRtt: type: boolean latestClinicallyAppropriateDate: type: string format: date 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 nullable: true items: type: string title: type: string Encounter.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Encounter.PatientPathway: type: object properties: _104WeeksBreachDate: type: string format: date _18WeeksBreachDate: type: string format: date _52WeeksBreachDate: type: string format: date _65WeeksBreachDate: type: string format: date _78WeeksBreachDate: type: string format: date accessibilityFlags: type: array nullable: true items: type: string admissionMethodCode: type: string age: type: string format: long closureReason: type: string consultantId: type: string consultantName: type: string covidPriority: type: string covidPriorityDate: type: string format: date dataSource: type: string dateOfBirth: type: string format: date daysTo104WeekBreachDate: type: integer daysTo18WeekBreachDate: type: integer daysTo52WeekBreachDate: type: integer daysTo65WeekBreachDate: type: integer daysTo78WeekBreachDate: type: integer derivedPathwayType: type: string directorate: type: string division: type: string dtaDate: type: string format: date intendedProcedureDescription: type: string isActiveRttPathway: type: boolean isOpenPathway: type: boolean 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 latestEpisodeId: type: string latestPathwayStatusCodeNational: type: string latestPathwayStatusDescriptionNational: type: string latestPeriodEndDate: type: string format: date latestPeriodEndReason: type: string latestPeriodLengthDays: type: integer latestPeriodLengthWeeks: type: integer latestPeriodStartDate: type: string format: date latestPeriodStartReason: type: string latestProcedurePriorityCode: type: string latestReferralReceivedDate: type: string format: date latestRttPeriodId: type: string 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 originalReferralSpecialtyId: type: string originalReferralSpecialtyName: type: string owlClinicCode: type: string owlFlag: type: boolean owlGroupCode: type: string pathwayClass: type: string pathwayEndDate: type: string format: date pathwayId: type: string pathwayStage: type: string pathwayStartDate: type: string format: date pathwayStatus: type: string pathwaySubtype: type: string pathwayType: type: string patientDeceased: type: boolean patientId: type: string patientName: type: string ppid: type: string ppidIssuer: type: string ppidIssuerOdsCode: type: string prospectiveRttPeriodEndDate: type: string format: date prospectiveRttWeeksWait: type: integer referralDate: type: string format: date referralId: type: string referralPriority: type: string referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true 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 waitingTimeMeasurementType: type: string waitingTimeMeasurementTypeCode: type: string waitingTimeMeasurementTypeCodeLocalCode: type: string weeksTo104WeekBreachDate: type: integer weeksTo18WeekBreachDate: type: integer weeksTo52WeekBreachDate: type: integer weeksTo65WeekBreachDate: type: integer weeksTo78WeekBreachDate: type: integer weeksWaitSinceDtaDate: type: integer weeksWaitSinceLastPatientContact: type: integer weeksWaitToProspectiveRttPeriodEndDate: type: integer weeksWaitToTciDate: type: integer Encounter.Procedure: type: object properties: actualProcedureTimeKnifeToSkinClosure: type: integer actualProcedureTimeTotalTheatreTime: type: integer admissionId: type: string admissionMethodDescription: type: string anaestheticTypeToBeUsed: type: string anaesthetistRequired: type: boolean appointmentId: type: string consultantEpisodeId: type: string 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 procedure: type: string procedureDate: type: string format: date procedureId: type: string procedureOpcsCode: type: string procedureOrdered: type: integer procedureSnomedCtCode: type: string procedureTimeOrOrder: type: string procedureTimestamp: type: string format: date-time responsibleAnaesthetistCareProfessionalId: type: string rvGroupIds: type: array nullable: true items: type: string theatreSessionId: type: string title: type: string uecAttendanceId: type: string virtualWardStayId: type: string Encounter.ProcedureStatus: 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 poaExpiryDate: type: string format: date poaOrdering: type: integer poaOutcome: type: string poaOutcomeDate: type: string format: date poaOutcomeFreeText: type: string poaScheduledOrAttendedDatetime: type: string format: date-time procedureId: type: string procedureStatusId: type: string rvGroupIds: type: array nullable: true items: type: string theatreBookingId: type: string Encounter.Specialty: type: object properties: isActiveSpecialty: type: boolean rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string theatreSpecialty: type: boolean Encounter.TheatreBooking: 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 lastPoaExpiryDate: type: string format: date lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string mrn: type: string patientId: type: string periOpRiskStratificationOutcome: type: string periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string status: type: string statusRender: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreSessionDate: type: string format: date theatreSessionId: type: string Encounter.ValidatedChangelog: type: object properties: actionType: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserGroup: type: string assignedUserIds: type: array nullable: true items: type: string careProfessionalId: type: string careProfessionalName: type: string changeLogId: type: string closedAt: type: string format: date-time closedBy: type: string commentUser: type: string comments: type: string daysOpen: type: integer description: type: string ealId: type: string encounterId: type: string externalId: type: string freeTextComments: type: string isRtt: type: boolean lastRefreshed: type: string format: date-time mrn: type: string newValue: type: string originatingWaitingListAlertRuleTypes: type: array nullable: true items: type: string originatingWaitingListAlertUniqueIds: type: array nullable: true items: type: string patientId: type: string patientName: type: string preResolved: type: boolean primaryConsultantId: type: string primaryConsultantName: type: string primaryEvidenceSource: type: string priority: type: string propertyToModify: type: string rcsClinicalHarmReview: type: string removalDate: type: string format: date removed: type: boolean requestedBy: type: string requiredAction: type: string resolved: type: boolean secondaryEvidenceSource: type: array nullable: true items: type: string siteId: type: string specialtyId: type: string specialtyName: type: string status: type: string statusUpdatedByUser: type: string statusUpdatedTimestamp: type: string format: date-time taskDueDate: type: string format: date taskPriority: type: string taskType: type: string timestamp: type: string format: date-time title: type: string unresolvedEncounterId: type: string validated: type: string ward: type: string Encounter.WaitlistEntry: type: object properties: addedTimestamp: type: string format: date-time dueDate: type: string format: date pathwayId: type: string removedTimestamp: type: string format: date-time rvGroupIds: type: array nullable: true items: type: string waitlistEntryId: type: string waitlistId: type: string Endoscopy.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string ErsService.ClinicSlot: 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 nullable: true items: type: string serviceIds: type: array nullable: true 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 ErsService.ClinicType: type: object properties: clinicTypeActive: type: boolean clinicTypeId: type: string clinicTypeName: type: string rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string ErsService.Referral: 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 isReferralToVirtualWard: type: boolean mrn: type: string pathwayId: type: array nullable: true items: type: string patientId: type: string patientIsOnCancerPathway: type: boolean presentingComplaint: type: string presentingComplaintIcd10Code: type: string presentingComplaintSnomedCtCode: type: string primaryCareProfessionalId: type: string primaryReferralReason: type: string primaryReferralReasonCode: type: string primaryReferralReasonToVirtualWardCode: type: string priority: type: string priorityCode: type: string priorityLocalCode: type: string referralId: type: string referralLetterContent: type: string referralLetterRid: $ref: "#/components/schemas/Core.MediaReference" referralNotes: type: string referralReceivedTimestamp: type: string format: date-time referralRejectionReason: type: string referralRejectionReasonCode: type: string referralRejectionTimestamp: type: string format: date-time referralSource: type: string referralSourceCode: type: string referralSourceLocalCode: type: string referralType: type: string referrerId: type: string referringOrganisation: type: string referringOrganisationOdsCode: type: string removed: type: boolean removedTimestamp: type: string format: date-time requestedAppointmentType: type: string requestedConsultationMechanism: type: string rttPathwayStatus: type: string rttPeriodEndDate: type: string format: date rttPeriodLength: type: integer rttPeriodStartDate: type: string format: date rvGroupIds: type: array nullable: true items: type: string serviceId: type: string serviceName: type: string serviceType: type: string serviceTypeRequested: type: string serviceTypeRequestedCode: type: string serviceTypeRequestedLocalCode: 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 treatmentFunction: type: string treatmentFunctionCode: type: string treatmentFunctionLocalCode: type: string trustOdsCode: type: string ubrn: type: string wasPatientReferredToDirectAccessService: type: boolean wasReferredByFirstContactPractitioner: type: boolean weeksWaiting: type: integer ErsService.Site: type: object properties: id: type: string name: type: string rvGroupIds: type: array nullable: true items: type: string siteOdsCode: type: string ErsService.Specialty: type: object properties: isActiveSpecialty: type: boolean rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string theatreSpecialty: type: boolean Finding.VirtualWardStay: type: object properties: activityLocationType: type: string activityLocationTypeCode: type: string admissionSource: type: string admissionSourceCode: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string endTimestamp: type: string format: date-time expectedCommissioner: type: string expectedCommissionerOdsCode: type: string isPatientSubjectToRemoteMonitoring: type: boolean methodOfDischarge: type: string methodOfDischargeCode: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time trustOdsCode: type: string virtualWardId: type: string virtualWardStayId: type: string Geo.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 Geo.GeoPoint: required: - coordinates - type type: object properties: bbox: $ref: "#/components/schemas/Geo.BBox" coordinates: $ref: "#/components/schemas/Geo.Position" type: type: string Geo.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/Geo.Position" Geo.Polygon: required: - type type: object properties: bbox: $ref: "#/components/schemas/Geo.BBox" coordinates: type: array items: $ref: "#/components/schemas/Geo.LinearRing" type: type: string Geo.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 GpPracticeRegistration.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Histology.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string HomeLeave.Admission: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string admissionExternalId: type: string admissionId: type: string admissionMethod: type: string admissionSource: type: string admissionSourceCode: type: string admissionSourceLocalCode: type: string admissionStatus: type: string admissionTimestamp: type: string format: date-time admissionTitle: type: string admissionType: type: string bedLocation: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string destinationOfDischargeLocalCode: type: string dischargeDestinationType: type: string dischargePathway: type: string dischargeReadyDate: type: string format: date dischargeTimestamp: type: string format: date-time ealEntryId: type: string encounterId: type: string estimatedDischargeDate: type: string format: date-time isDischargeTimeConfirmed: type: boolean localAuthority: type: string methodOfAdmission: type: string methodOfAdmissionCode: type: string methodOfAdmissionLocalCode: type: string methodOfDischarge: type: string methodOfDischargeCode: type: string methodOfDischargeLocalCode: type: string pathwayId: type: string patientClassification: type: string patientClassificationCode: type: string patientClassificationLocalCode: type: string patientId: type: string patientName: type: string rvGroupIds: type: array nullable: true items: type: string siteName: type: string specialtyId: type: string specialtyName: type: string startTimestamp: type: string format: date-time treatmentFunctionCode: type: string ward: type: string wasPatientDischargedToNhsAtHomeService: type: boolean HomeLeave.ConsultantEpisode: type: object properties: admissionId: type: string consultantEpisodeExternalId: type: string consultantEpisodeId: type: string consultantEpisodeSequenceNumber: type: integer endTimestamp: type: string format: date-time healthcareProvider: type: string healthcareProviderOdsCode: type: string patientId: type: string psychiatricPatientStatus: type: string psychiatricPatientStatusCode: type: string psychiatricPatientStatusLocalCode: type: string rehabilitationAssessmentTeamType: type: string rehabilitationAssessmentTeamTypeCode: type: string rehabilitationAssessmentTeamTypeLocalCode: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time totalNumberOfRehabilitationDays: type: integer totalNumberOfSpecialistPalliativeCareDays: type: integer treatmentFunction: type: string treatmentFunctionCode: type: string HomeLeave.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Injury.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Injury.UecAttendance: type: object properties: acuity: type: string acuitySnomedCtCode: type: string admissionId: type: string ambulanceCallId: type: string ambulanceIncidentId: type: string arrivalMode: type: string arrivalModeSnomedCtCode: type: string arrivalTimestamp: type: string format: date-time attendanceSource: type: string attendanceSourceSite: type: string attendanceSourceSiteOdsCode: type: string attendanceSourceSnomedCtCode: type: string chiefComplaint: type: string chiefComplaintSnomedCtCode: type: string clinicallyReadyToProceedTimestamp: type: string format: date-time consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string conveyingAmbulanceTrust: type: string conveyingAmbulanceTrustOdsCode: type: string decisionToAdmitTimestamp: type: string format: date-time departureTimestamp: type: string format: date-time dischargeDestination: type: string dischargeDestinationSnomedCtCode: type: string dischargeFollowUp: type: string dischargeFollowUpSnomedCtCode: type: string dischargeSite: type: string dischargeSiteOdsCode: type: string dischargeStatus: type: string dischargeStatusSnomedCtCode: type: string edExtendedCareEpisodeId: type: string emergencyCareDepartmentType: type: string emergencyCareDepartmentTypeCode: type: string emergencyCareDepartmentTypeLocalCode: type: string expectedTreatmentAllocationTimestamp: type: string format: date-time expectedTreatmentTimestamp: type: string format: date-time hasDischargeInformationBeenGiven: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string initialAssessmentTimestamp: type: string format: date-time patientId: type: string rvGroupIds: type: array nullable: true items: type: string safeguardingConcerns: type: array nullable: true items: type: string safeguardingConcernsSnomedCtCodes: type: array nullable: true items: type: string seenForTreatmentTimestamp: type: string format: date-time treatmentSite: type: string treatmentSiteOdsCode: type: string uecAttendanceExternalId: type: string uecAttendanceId: type: string urgentAndEmergencyCareAttendanceCategory: type: string urgentAndEmergencyCareAttendanceCategoryCode: type: string urgentAndEmergencyCareAttendanceCategoryLocalCode: type: string InterProviderTransfer.CancerPathway: type: object properties: _24DayBreachDate: type: string format: date _28DayBreachDate: type: string format: date _31DayBreachDate: type: string format: date _62DayBreachDate: type: string format: date adjustedPathwayStartDate: type: string format: date birthDate: type: string format: date cancerPathwayId: type: string cancerSite: type: string cancerSubSite: type: string daysSinceAdjustedPathwayStart: type: integer daysSinceAdjustedPathwayStartBucket: type: string deathDate: type: string format: date decisionToTreatDate: type: string format: date diagnosis: type: string diagnosisDate: type: string format: date diagnosisIcd10Code: type: string firstName: type: string firstSeenDate: type: string format: date firstSeenSite: type: string firstSeenSiteOdsCode: type: string firstTreatmentDate: type: string format: date firstTreatmentType: type: string fullName: type: string hospitalSite: type: string hospitalSiteId: type: string is28DayPathwayOpen: type: boolean is31DayPathwayOpen: type: boolean is62DayPathwayOpen: type: boolean isAnyPathwayTypeOpen: type: boolean isBenign: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time mrn: type: string nhsNumber: type: string organisationSiteTreatment: type: string originalPathwayStartDate: type: string format: date pathwayClosedDate: type: string format: date pathwayStatus: type: string pathwayType: type: string patientId: type: string patientInformedDate: type: string format: date referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string surname: type: string title: type: string treatmentSite: type: string treatmentSiteOdsCode: type: string treatmentType: type: string upgradeDate: type: string format: date waitingTimeAdjustmentDays: type: integer InterProviderTransfer.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Labour.Admission: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string admissionExternalId: type: string admissionId: type: string admissionMethod: type: string admissionSource: type: string admissionSourceCode: type: string admissionSourceLocalCode: type: string admissionStatus: type: string admissionTimestamp: type: string format: date-time admissionTitle: type: string admissionType: type: string bedLocation: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string destinationOfDischargeLocalCode: type: string dischargeDestinationType: type: string dischargePathway: type: string dischargeReadyDate: type: string format: date dischargeTimestamp: type: string format: date-time ealEntryId: type: string encounterId: type: string estimatedDischargeDate: type: string format: date-time isDischargeTimeConfirmed: type: boolean localAuthority: type: string methodOfAdmission: type: string methodOfAdmissionCode: type: string methodOfAdmissionLocalCode: type: string methodOfDischarge: type: string methodOfDischargeCode: type: string methodOfDischargeLocalCode: type: string pathwayId: type: string patientClassification: type: string patientClassificationCode: type: string patientClassificationLocalCode: type: string patientId: type: string patientName: type: string rvGroupIds: type: array nullable: true items: type: string siteName: type: string specialtyId: type: string specialtyName: type: string startTimestamp: type: string format: date-time treatmentFunctionCode: type: string ward: type: string wasPatientDischargedToNhsAtHomeService: type: boolean Labour.Birth: type: object properties: admissionId: type: string babyPatientId: type: string birthId: type: string birthSequenceNumber: type: integer birthWeightGrams: type: integer deliveryMethod: type: string deliveryMethodCode: type: string deliveryMethodLocalCode: type: string gestationLengthWeeks: type: integer isStillBirth: type: boolean labourId: type: string liveOrStillBirth: type: string liveOrStillBirthCode: type: string liveOrStillBirthLocalCode: type: string pregnancyId: type: string resuscitationMethod: type: string resuscitationMethodCode: type: string resuscitationMethodLocalCode: type: string rvGroupIds: type: array nullable: true items: type: string statusOfPersonConductingDelivery: type: string statusOfPersonConductingDeliveryCode: type: string statusOfPersonConductingDeliveryLocalCode: type: string Labour.ConsultantEpisode: type: object properties: admissionId: type: string consultantEpisodeExternalId: type: string consultantEpisodeId: type: string consultantEpisodeSequenceNumber: type: integer endTimestamp: type: string format: date-time healthcareProvider: type: string healthcareProviderOdsCode: type: string patientId: type: string psychiatricPatientStatus: type: string psychiatricPatientStatusCode: type: string psychiatricPatientStatusLocalCode: type: string rehabilitationAssessmentTeamType: type: string rehabilitationAssessmentTeamTypeCode: type: string rehabilitationAssessmentTeamTypeLocalCode: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time totalNumberOfRehabilitationDays: type: integer totalNumberOfSpecialistPalliativeCareDays: type: integer treatmentFunction: type: string treatmentFunctionCode: type: string Labour.Pregnancy: type: object properties: antenatalResponsibleGpCareProfessionalId: type: string firstAntenatalAssessmentDate: type: string format: date intendedDeliveryPlace: type: string intendedDeliveryPlaceCode: type: string intendedDeliveryPlaceCodeLocalCode: type: string numberOfPreviousPregnanciesResultingInRegistrableBirths: type: integer patientId: type: string pregnancyId: type: string rvGroupIds: type: array nullable: true items: type: string LogEditCdmModulePermissioning.CdmModulePermissioning: type: object properties: moduleGroupIds: type: array nullable: true items: type: string moduleName: type: string LogUpdateOptionalGroupIdsForObjectPermissioning.CdmObjectPermissioning: type: object properties: modules: type: array nullable: true items: type: string objectGroupIds: type: array nullable: true items: type: string objectId: type: string objectName: type: string MdtMeeting.CancerPathway: type: object properties: _24DayBreachDate: type: string format: date _28DayBreachDate: type: string format: date _31DayBreachDate: type: string format: date _62DayBreachDate: type: string format: date adjustedPathwayStartDate: type: string format: date birthDate: type: string format: date cancerPathwayId: type: string cancerSite: type: string cancerSubSite: type: string daysSinceAdjustedPathwayStart: type: integer daysSinceAdjustedPathwayStartBucket: type: string deathDate: type: string format: date decisionToTreatDate: type: string format: date diagnosis: type: string diagnosisDate: type: string format: date diagnosisIcd10Code: type: string firstName: type: string firstSeenDate: type: string format: date firstSeenSite: type: string firstSeenSiteOdsCode: type: string firstTreatmentDate: type: string format: date firstTreatmentType: type: string fullName: type: string hospitalSite: type: string hospitalSiteId: type: string is28DayPathwayOpen: type: boolean is31DayPathwayOpen: type: boolean is62DayPathwayOpen: type: boolean isAnyPathwayTypeOpen: type: boolean isBenign: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time mrn: type: string nhsNumber: type: string organisationSiteTreatment: type: string originalPathwayStartDate: type: string format: date pathwayClosedDate: type: string format: date pathwayStatus: type: string pathwayType: type: string patientId: type: string patientInformedDate: type: string format: date referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string surname: type: string title: type: string treatmentSite: type: string treatmentSiteOdsCode: type: string treatmentType: type: string upgradeDate: type: string format: date waitingTimeAdjustmentDays: type: integer MdtMeeting.MdtNote: type: object properties: cancerPathwayId: type: string lastRefreshedAtSourceTimestamp: type: string format: date-time lastUpdatedTimestamp: type: string format: date-time mdtMeetingId: type: string mdtNoteId: type: string mdtNoteText: type: string noteType: type: string rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string MdtNote.CancerPathway: type: object properties: _24DayBreachDate: type: string format: date _28DayBreachDate: type: string format: date _31DayBreachDate: type: string format: date _62DayBreachDate: type: string format: date adjustedPathwayStartDate: type: string format: date birthDate: type: string format: date cancerPathwayId: type: string cancerSite: type: string cancerSubSite: type: string daysSinceAdjustedPathwayStart: type: integer daysSinceAdjustedPathwayStartBucket: type: string deathDate: type: string format: date decisionToTreatDate: type: string format: date diagnosis: type: string diagnosisDate: type: string format: date diagnosisIcd10Code: type: string firstName: type: string firstSeenDate: type: string format: date firstSeenSite: type: string firstSeenSiteOdsCode: type: string firstTreatmentDate: type: string format: date firstTreatmentType: type: string fullName: type: string hospitalSite: type: string hospitalSiteId: type: string is28DayPathwayOpen: type: boolean is31DayPathwayOpen: type: boolean is62DayPathwayOpen: type: boolean isAnyPathwayTypeOpen: type: boolean isBenign: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time mrn: type: string nhsNumber: type: string organisationSiteTreatment: type: string originalPathwayStartDate: type: string format: date pathwayClosedDate: type: string format: date pathwayStatus: type: string pathwayType: type: string patientId: type: string patientInformedDate: type: string format: date referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string surname: type: string title: type: string treatmentSite: type: string treatmentSiteOdsCode: type: string treatmentType: type: string upgradeDate: type: string format: date waitingTimeAdjustmentDays: type: integer MdtNote.mdtMeeting: type: object properties: lastRefreshedAtSourceTimestamp: type: string format: date-time mdtMeetingId: type: string mdtStatus: type: string meetingTimestamp: type: string format: date-time rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string MentalHealthActLegalStatus.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Observation.VirtualWardStay: type: object properties: activityLocationType: type: string activityLocationTypeCode: type: string admissionSource: type: string admissionSourceCode: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string endTimestamp: type: string format: date-time expectedCommissioner: type: string expectedCommissionerOdsCode: type: string isPatientSubjectToRemoteMonitoring: type: boolean methodOfDischarge: type: string methodOfDischargeCode: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time trustOdsCode: type: string virtualWardId: type: string virtualWardStayId: type: string Ontologies.AggregateObjectsRequestV2: type: object properties: accuracy: $ref: "#/components/schemas/Ontologies.AggregationAccuracyRequest" aggregation: type: array items: $ref: "#/components/schemas/Ontologies.AggregationV2" groupBy: type: array items: $ref: "#/components/schemas/Ontologies.AggregationGroupByV2" where: $ref: "#/components/schemas/Ontologies.SearchJsonQueryV2" Ontologies.AggregateObjectsResponseItemV2: type: object properties: group: type: object additionalProperties: {} nullable: true metrics: type: array items: $ref: "#/components/schemas/Ontologies.AggregationMetricResultV2" Ontologies.AggregateObjectsResponseV2: required: - accuracy type: object properties: accuracy: $ref: "#/components/schemas/Ontologies.AggregationAccuracy" computeUsage: type: number format: double data: type: array items: $ref: "#/components/schemas/Ontologies.AggregateObjectsResponseItemV2" excludedItems: type: integer Ontologies.AggregationAccuracy: type: string enum: - ACCURATE - APPROXIMATE Ontologies.AggregationAccuracyRequest: type: string enum: - REQUIRE_ACCURATE - ALLOW_APPROXIMATE Ontologies.AggregationDurationGroupingV2: required: - field - type - unit - value type: object properties: field: type: string type: type: string unit: $ref: "#/components/schemas/Ontologies.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`. Ontologies.AggregationExactGroupingV2: required: - field - type type: object properties: defaultValue: type: string description: | Includes a group with the specified default value that includes all objects where the specified field's value is null. Cannot be used with includeNullValues. field: type: string includeNullValues: type: boolean description: | Includes a group with a null value that includes all objects where the specified field's value is null. Cannot be used with defaultValue or orderBy clauses on the aggregation. maxGroupCount: type: integer type: type: string description: Divides objects into groups according to an exact value. Ontologies.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. Ontologies.AggregationGroupByV2: description: Specifies a grouping for aggregation results. discriminator: propertyName: type mapping: duration: "#/components/schemas/Ontologies.AggregationDurationGroupingV2" exact: "#/components/schemas/Ontologies.AggregationExactGroupingV2" fixedWidth: "#/components/schemas/Ontologies.AggregationFixedWidthGroupingV2" ranges: "#/components/schemas/Ontologies.AggregationRangesGroupingV2" oneOf: - $ref: "#/components/schemas/Ontologies.AggregationDurationGroupingV2" - $ref: "#/components/schemas/Ontologies.AggregationFixedWidthGroupingV2" - $ref: "#/components/schemas/Ontologies.AggregationRangesGroupingV2" - $ref: "#/components/schemas/Ontologies.AggregationExactGroupingV2" Ontologies.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. Ontologies.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. Ontologies.AggregationRangesGroupingV2: required: - field - type type: object properties: field: type: string ranges: type: array items: $ref: "#/components/schemas/Ontologies.AggregationRangeV2" type: type: string description: Divides objects into groups according to specified ranges. Ontologies.AggregationV2: description: Specifies an aggregation function. discriminator: propertyName: type mapping: approximateDistinct: "#/components/schemas/Ontologies.ApproximateDistinctAggregationV2" approximatePercentile: "#/components/schemas/Ontologies.ApproximatePercentileAggregationV2" avg: "#/components/schemas/Ontologies.AvgAggregationV2" count: "#/components/schemas/Ontologies.CountAggregationV2" exactDistinct: "#/components/schemas/Ontologies.ExactDistinctAggregationV2" max: "#/components/schemas/Ontologies.MaxAggregationV2" min: "#/components/schemas/Ontologies.MinAggregationV2" sum: "#/components/schemas/Ontologies.SumAggregationV2" oneOf: - $ref: "#/components/schemas/Ontologies.ApproximateDistinctAggregationV2" - $ref: "#/components/schemas/Ontologies.MinAggregationV2" - $ref: "#/components/schemas/Ontologies.AvgAggregationV2" - $ref: "#/components/schemas/Ontologies.MaxAggregationV2" - $ref: "#/components/schemas/Ontologies.ApproximatePercentileAggregationV2" - $ref: "#/components/schemas/Ontologies.CountAggregationV2" - $ref: "#/components/schemas/Ontologies.SumAggregationV2" - $ref: "#/components/schemas/Ontologies.ExactDistinctAggregationV2" Ontologies.AndQueryV2: required: - type type: object properties: type: type: string value: type: array items: $ref: "#/components/schemas/Ontologies.SearchJsonQueryV2" description: Returns objects where every query is satisfied. Ontologies.ApproximateDistinctAggregationV2: required: - field - type type: object properties: direction: $ref: "#/components/schemas/Ontologies.OrderByDirection" field: type: string name: type: string type: type: string description: Computes an approximate number of distinct values for the provided field. Ontologies.ApproximatePercentileAggregationV2: required: - approximatePercentile - field - type type: object properties: approximatePercentile: type: number format: double direction: $ref: "#/components/schemas/Ontologies.OrderByDirection" field: type: string name: type: string type: type: string description: Computes the approximate percentile value for the provided field. Requires Object Storage V2. Ontologies.AvgAggregationV2: required: - field - type type: object properties: direction: $ref: "#/components/schemas/Ontologies.OrderByDirection" field: type: string name: type: string type: type: string description: Computes the average value for the provided field. Ontologies.BoundingBoxValue: required: - bottomRight - topLeft type: object properties: bottomRight: $ref: "#/components/schemas/Ontologies.WithinBoundingBoxPoint" topLeft: $ref: "#/components/schemas/Ontologies.WithinBoundingBoxPoint" description: | The top left and bottom right coordinate points that make up the bounding box. Ontologies.CenterPoint: required: - center - distance type: object properties: center: $ref: "#/components/schemas/Ontologies.CenterPointTypes" distance: $ref: "#/components/schemas/Core.Distance" description: | The coordinate point to use as the center of the distance query. Ontologies.CenterPointTypes: discriminator: propertyName: type mapping: Point: "#/components/schemas/Geo.GeoPoint" oneOf: - $ref: "#/components/schemas/Geo.GeoPoint" Ontologies.ContainsAllTermsInOrderPrefixLastTerm: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: type: string example: foo bar 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. Allows you to specify a property\ \ to query on\nby a variety of means. Either `field` or `propertyIdentifier`\ \ can be supplied, but not both.\n" Ontologies.ContainsAllTermsInOrderQuery: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: type: string example: foo bar 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. Allows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. Ontologies.ContainsAllTermsQuery: required: - type - value type: object properties: field: type: string fuzzy: type: boolean propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: type: string example: foo bar description: "Returns objects where the specified field contains all of the\ \ whitespace separated words in any\norder in the provided value. This query\ \ supports fuzzy matching. Allows you to specify a property to query on \n\ by a variety of means. Either `field` or `propertyIdentifier` must be supplied,\ \ but not both.\n" Ontologies.ContainsAnyTermQuery: required: - type - value type: object properties: field: type: string fuzzy: type: boolean propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: type: string example: foo bar 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. Allows you to specify a property to query on\n\ by a variety of means. Either `field` or `propertyIdentifier` must be supplied,\ \ but not both.\n" Ontologies.ContainsQueryV2: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: {} description: "Returns objects where the specified array contains a value. Allows\ \ you to specify a property to query on by a \nvariety of means. Either `field`\ \ or `propertyIdentifier` must be supplied, but not both.\n" Ontologies.CountAggregationV2: required: - type type: object properties: direction: $ref: "#/components/schemas/Ontologies.OrderByDirection" name: type: string type: type: string description: Computes the total count of objects. Ontologies.CountObjectsResponseV2: type: object properties: count: type: integer Ontologies.DoesNotIntersectBoundingBoxQuery: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: $ref: "#/components/schemas/Ontologies.BoundingBoxValue" description: "Returns objects where the specified field does not intersect the\ \ bounding box provided. Allows you to specify a \nproperty to query on by\ \ a variety of means. Either `field` or `propertyIdentifier` must be supplied,\ \ but not \nboth.\n" Ontologies.DoesNotIntersectPolygonQuery: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: $ref: "#/components/schemas/Ontologies.PolygonValue" description: "Returns objects where the specified field does not intersect the\ \ polygon provided. Allows you to specify a \nproperty to query on by a variety\ \ of means. Either `field` or `propertyIdentifier` must be supplied, but not\ \ \nboth.\n" Ontologies.EqualsQueryV2: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: {} description: | Returns objects where the specified field is equal to a value. Allows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. Ontologies.ExactDistinctAggregationV2: required: - field - type type: object properties: direction: $ref: "#/components/schemas/Ontologies.OrderByDirection" field: type: string name: type: string type: type: string description: Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. Ontologies.GtQueryV2: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: {} description: | Returns objects where the specified field is greater than a value. Allows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. Ontologies.GteQueryV2: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: {} description: "Returns objects where the specified field is greater than or equal\ \ to a value. Allows you to specify a property \nto query on by a variety\ \ of means. Either `field` or `propertyIdentifier` must be supplied, but not\ \ both.\n" Ontologies.InQuery: required: - type type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: type: array items: {} description: "Returns objects where the specified field equals any of the provided\ \ values. Allows you to\nspecify a property to query on by a variety of means.\ \ Either `field` or `propertyIdentifier` must be supplied, \nbut not both.\n" Ontologies.IntersectsBoundingBoxQuery: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: $ref: "#/components/schemas/Ontologies.BoundingBoxValue" description: "Returns objects where the specified field intersects the bounding\ \ box provided. Allows you to specify a property \nto query on by a variety\ \ of means. Either `field` or `propertyIdentifier` must be supplied, but not\ \ both.\n" Ontologies.IntersectsPolygonQuery: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: $ref: "#/components/schemas/Ontologies.PolygonValue" description: "Returns objects where the specified field intersects the polygon\ \ provided. Allows you to specify a property to \nquery on by a variety of\ \ means. Either `field` or `propertyIdentifier` must be supplied, but not\ \ both.\n" Ontologies.IsNullQueryV2: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: type: boolean example: false description: | Returns objects based on the existence of the specified field. Allows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. Ontologies.LtQueryV2: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: {} description: "Returns objects where the specified field is less than a value.\ \ Allows you to specify a property to query on \nby a variety of means. Either\ \ `field` or `propertyIdentifier` must be supplied, but not both.\n" Ontologies.LteQueryV2: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: {} description: "Returns objects where the specified field is less than or equal\ \ to a value. Allows you to specify a property to \nquery on by a variety\ \ of means. Either `field` or `propertyIdentifier` must be supplied, but not\ \ both.\n" Ontologies.MaxAggregationV2: required: - field - type type: object properties: direction: $ref: "#/components/schemas/Ontologies.OrderByDirection" field: type: string name: type: string type: type: string description: Computes the maximum value for the provided field. Ontologies.MinAggregationV2: required: - field - type type: object properties: direction: $ref: "#/components/schemas/Ontologies.OrderByDirection" field: type: string name: type: string type: type: string description: Computes the minimum value for the provided field. Ontologies.NotQueryV2: required: - type - value type: object properties: type: type: string value: $ref: "#/components/schemas/Ontologies.SearchJsonQueryV2" description: Returns objects where the query is not satisfied. Ontologies.OrQueryV2: required: - type type: object properties: type: type: string value: type: array items: $ref: "#/components/schemas/Ontologies.SearchJsonQueryV2" description: Returns objects where at least 1 query is satisfied. Ontologies.OrderByDirection: type: string enum: - ASC - DESC Ontologies.PolygonValue: discriminator: propertyName: type mapping: Polygon: "#/components/schemas/Geo.Polygon" oneOf: - $ref: "#/components/schemas/Geo.Polygon" Ontologies.PropertyApiNameSelector: required: - apiName - type type: object properties: apiName: type: string type: type: string description: A property api name that references properties to query on. Ontologies.PropertyIdentifier: description: An identifier used to select properties or struct fields. discriminator: propertyName: type mapping: property: "#/components/schemas/Ontologies.PropertyApiNameSelector" structField: "#/components/schemas/Ontologies.StructFieldSelector" oneOf: - $ref: "#/components/schemas/Ontologies.PropertyApiNameSelector" - $ref: "#/components/schemas/Ontologies.StructFieldSelector" Ontologies.SearchJsonQueryV2: discriminator: propertyName: type mapping: and: "#/components/schemas/Ontologies.AndQueryV2" contains: "#/components/schemas/Ontologies.ContainsQueryV2" containsAllTerms: "#/components/schemas/Ontologies.ContainsAllTermsQuery" containsAllTermsInOrder: "#/components/schemas/Ontologies.ContainsAllTermsInOrderQuery" containsAllTermsInOrderPrefixLastTerm: "#/components/schemas/Ontologies.ContainsAllTermsInOrderPrefixLastTerm" containsAnyTerm: "#/components/schemas/Ontologies.ContainsAnyTermQuery" doesNotIntersectBoundingBox: "#/components/schemas/Ontologies.DoesNotIntersectBoundingBoxQuery" doesNotIntersectPolygon: "#/components/schemas/Ontologies.DoesNotIntersectPolygonQuery" eq: "#/components/schemas/Ontologies.EqualsQueryV2" gt: "#/components/schemas/Ontologies.GtQueryV2" gte: "#/components/schemas/Ontologies.GteQueryV2" in: "#/components/schemas/Ontologies.InQuery" intersectsBoundingBox: "#/components/schemas/Ontologies.IntersectsBoundingBoxQuery" intersectsPolygon: "#/components/schemas/Ontologies.IntersectsPolygonQuery" isNull: "#/components/schemas/Ontologies.IsNullQueryV2" lt: "#/components/schemas/Ontologies.LtQueryV2" lte: "#/components/schemas/Ontologies.LteQueryV2" not: "#/components/schemas/Ontologies.NotQueryV2" or: "#/components/schemas/Ontologies.OrQueryV2" startsWith: "#/components/schemas/Ontologies.StartsWithQuery" withinBoundingBox: "#/components/schemas/Ontologies.WithinBoundingBoxQuery" withinDistanceOf: "#/components/schemas/Ontologies.WithinDistanceOfQuery" withinPolygon: "#/components/schemas/Ontologies.WithinPolygonQuery" oneOf: - $ref: "#/components/schemas/Ontologies.OrQueryV2" - $ref: "#/components/schemas/Ontologies.InQuery" - $ref: "#/components/schemas/Ontologies.DoesNotIntersectPolygonQuery" - $ref: "#/components/schemas/Ontologies.LtQueryV2" - $ref: "#/components/schemas/Ontologies.DoesNotIntersectBoundingBoxQuery" - $ref: "#/components/schemas/Ontologies.EqualsQueryV2" - $ref: "#/components/schemas/Ontologies.ContainsAllTermsQuery" - $ref: "#/components/schemas/Ontologies.GtQueryV2" - $ref: "#/components/schemas/Ontologies.WithinDistanceOfQuery" - $ref: "#/components/schemas/Ontologies.WithinBoundingBoxQuery" - $ref: "#/components/schemas/Ontologies.ContainsQueryV2" - $ref: "#/components/schemas/Ontologies.NotQueryV2" - $ref: "#/components/schemas/Ontologies.IntersectsBoundingBoxQuery" - $ref: "#/components/schemas/Ontologies.AndQueryV2" - $ref: "#/components/schemas/Ontologies.IsNullQueryV2" - $ref: "#/components/schemas/Ontologies.ContainsAllTermsInOrderPrefixLastTerm" - $ref: "#/components/schemas/Ontologies.ContainsAnyTermQuery" - $ref: "#/components/schemas/Ontologies.GteQueryV2" - $ref: "#/components/schemas/Ontologies.ContainsAllTermsInOrderQuery" - $ref: "#/components/schemas/Ontologies.WithinPolygonQuery" - $ref: "#/components/schemas/Ontologies.IntersectsPolygonQuery" - $ref: "#/components/schemas/Ontologies.LteQueryV2" - $ref: "#/components/schemas/Ontologies.StartsWithQuery" Ontologies.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/Ontologies.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 snapshot: type: boolean description: | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. where: $ref: "#/components/schemas/Ontologies.SearchJsonQueryV2" Ontologies.SearchOrderByType: type: string enum: - fields - relevance Ontologies.SearchOrderByV2: type: object properties: fields: type: array items: $ref: "#/components/schemas/Ontologies.SearchOrderingV2" orderType: $ref: "#/components/schemas/Ontologies.SearchOrderByType" description: Specifies the ordering of search results by a field and an ordering direction or by relevance if scores are required in a nearestNeighbors query. By default `orderType` is set to `fields`. Ontologies.SearchOrderingV2: required: - field type: object properties: direction: type: string description: Specifies the ordering direction (can be either `asc` or `desc`) field: type: string Ontologies.StartsWithQuery: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: type: string example: foo description: "Deprecated alias for `containsAllTermsInOrderPrefixLastTerm`,\ \ which is preferred because the name `startsWith` is misleading.\nReturns\ \ objects where the specified field starts with the provided value. Allows\ \ you to specify a property to \nquery on by a variety of means. Either `field`\ \ or `propertyIdentifier` must be supplied, but not both.\n" Ontologies.StructFieldSelector: required: - propertyApiName - structFieldApiName - type type: object properties: propertyApiName: type: string structFieldApiName: type: string type: type: string description: | A combination of a property API name and a struct field API name used to select struct fields. Note that you can still select struct properties with only a 'PropertyApiNameSelector'; the queries will then become 'OR' queries across the fields of the struct property, and derived property expressions will operate on the whole struct where applicable. Ontologies.SumAggregationV2: required: - field - type type: object properties: direction: $ref: "#/components/schemas/Ontologies.OrderByDirection" field: type: string name: type: string type: type: string description: Computes the sum of values for the provided field. Ontologies.TimeUnit: type: string enum: - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - WEEKS - MONTHS - YEARS - QUARTERS Ontologies.WithinBoundingBoxPoint: discriminator: propertyName: type mapping: Point: "#/components/schemas/Geo.GeoPoint" oneOf: - $ref: "#/components/schemas/Geo.GeoPoint" Ontologies.WithinBoundingBoxQuery: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: $ref: "#/components/schemas/Ontologies.BoundingBoxValue" description: "Returns objects where the specified field contains a point within\ \ the bounding box provided. Allows you to \nspecify a property to query on\ \ by a variety of means. Either `field` or `propertyIdentifier` must be supplied,\ \ \nbut not both.\n" Ontologies.WithinDistanceOfQuery: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: $ref: "#/components/schemas/Ontologies.CenterPoint" description: "Returns objects where the specified field contains a point within\ \ the distance provided of the center point.\nAllows you to specify a property\ \ to query on by a variety of means. Either `field` or `propertyIdentifier`\ \ \nmust be supplied, but not both.\n" Ontologies.WithinPolygonQuery: required: - type - value type: object properties: field: type: string propertyIdentifier: $ref: "#/components/schemas/Ontologies.PropertyIdentifier" type: type: string value: $ref: "#/components/schemas/Ontologies.PolygonValue" description: "Returns objects where the specified field contains a point within\ \ the polygon provided. Allows you to specify a \nproperty to query on by\ \ a variety of means. Either `field` or `propertyIdentifier` must be supplied,\ \ but not \nboth.\n" Osdk.Admission: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string administrativeCategory: type: string description: "Whether the patient is a private patient, NHS patient etc.\ \ https://www.datadictionary.nhs.uk/attributes/administrative_category_code.html" administrativeCategoryCode: type: string description: "Whether the patient is a private patient, NHS patient etc.\ \ https://www.datadictionary.nhs.uk/attributes/administrative_category_code.html" administrativeCategoryLocalCode: type: string description: "Whether the patient is a private patient, NHS patient etc." admissionExternalId: type: string description: "External identifier for the admission. An external identifier\ \ is a unique identifier, used to link data or users across different\ \ systems or platforms, especially when those systems don't share a common\ \ database or identifier." 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 admissionSource: type: string description: The source of admission when the patient is in a hospital site or a care home. https://www.datadictionary.nhs.uk/attributes/admission_source.html admissionSourceCode: type: string description: The source of admission when the patient is in a hospital site or a care home. https://www.datadictionary.nhs.uk/attributes/admission_source.html admissionSourceLocalCode: type: string description: The source of admission when the patient is in a hospital site or a care home. 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" bedLocation: type: string description: The latest bed number to which patient was admitted destinationOfDischarge: type: string description: The destination the patient was discharged to. https://www.datadictionary.nhs.uk/attributes/destination_of_discharge.html destinationOfDischargeCode: type: string description: The destination the patient was discharged to. https://www.datadictionary.nhs.uk/attributes/destination_of_discharge.html destinationOfDischargeLocalCode: type: string description: The destination the patient was discharged to. 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" dischargeReadyDate: type: string description: The date that the patient no longer met the 'Criteria to Reside' in the hospital bed. https://www.datadictionary.nhs.uk/nhs_business_definitions/discharge_ready_date.html format: date dischargeTimestamp: type: string description: Timetamp of patient discharge from hospital format: date-time ealEntryId: type: string description: Foreign key to the EAL Entry for this admission. 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 methodOfAdmission: type: string description: The method of admission. https://www.datadictionary.nhs.uk/attributes/method_of_admission.html methodOfAdmissionCode: type: string description: The method of admission. https://www.datadictionary.nhs.uk/attributes/method_of_admission.html methodOfAdmissionLocalCode: type: string description: The method of admission. methodOfDischarge: type: string description: The method of discharge. https://www.datadictionary.nhs.uk/attributes/method_of_discharge.html methodOfDischargeCode: type: string description: The method of discharge. https://www.datadictionary.nhs.uk/attributes/method_of_discharge.html methodOfDischargeLocalCode: type: string description: The method of discharge. pathwayId: type: string description: Foreign key to the pathway the admission lies on. patientClassification: type: string description: "The type of admission i.e. ordinary, day case, regular day\ \ etc. https://www.datadictionary.nhs.uk/attributes/patient_classification.html" patientClassificationCode: type: string description: https://www.datadictionary.nhs.uk/data_elements/patient_classification_code.html patientClassificationLocalCode: type: string description: "The type of admission i.e. ordinary, day case, regular day\ \ etc." 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 nullable: true 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 startTimestamp: type: string description: The timestamp the admission started. https://www.datadictionary.nhs.uk/data_elements/start_date__hospital_provider_spell_.html format: date-time treatmentFunctionCode: type: string description: "Treatment Function Code (TFC), the specialty that the patient\ \ is being treated for. TFC __should__ be derived from the latest entry\ \ for the admission in consultant_episode (CE). If CE is not available,\ \ TFC can be specified directly here in admission. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html" ward: type: string description: The latest ward to which patient was admitted wasPatientDischargedToNhsAtHomeService: type: boolean description: "A boolean that's true if the patient was discharged to an\ \ NHS at Home Service. NHS @home is an approach to providing better connected,\ \ more personalised care in people's homes, including care homes. https://www.datadictionary.nhs.uk/attributes/discharged_to_nhs_at_home_service_indicator.html" description: "" Osdk.AdmissionProperties: type: string enum: - pathwayId - isDischargeTimeConfirmed - patientName - administrativeCategory - treatmentFunctionCode - dischargeTimestamp - estimatedDischargeDate - patientClassificationLocalCode - rvGroupIds - patientClassification - destinationOfDischargeLocalCode - admissionSourceCode - methodOfDischargeLocalCode - specialtyId - dischargePathway - startTimestamp - bedLocation - patientClassificationCode - admissionId - admissionMethod - ward - localAuthority - admissionSourceLocalCode - destinationOfDischarge - patientId - dischargeReadyDate - administrativeCategoryCode - admissionExternalId - ealEntryId - methodOfAdmissionLocalCode - admissionTitle - admissionSource - siteName - administrativeCategoryLocalCode - methodOfDischargeCode - methodOfDischarge - destinationOfDischargeCode - methodOfAdmission - specialtyName - dischargeDestinationType - encounterId - admissionType - admissionTimestamp - methodOfAdmissionCode - wasPatientDischargedToNhsAtHomeService - admissionStatus Osdk.Appointment: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string administrativeCategory: type: string description: "Whether the patient is a private patient, NHS patient etc.\ \ https://www.datadictionary.nhs.uk/attributes/administrative_category_code.html" administrativeCategoryCode: type: string description: "Whether the patient is a private patient, NHS patient etc.\ \ https://www.datadictionary.nhs.uk/attributes/administrative_category_code.html" administrativeCategoryLocalCode: type: string description: "Whether the patient is a private patient, NHS patient etc." appointmentBookedReason: type: string description: The cause of the appointment being booked. https://www.datadictionary.nhs.uk/attributes/appointment_booked_reason.html appointmentBookedReasonCode: type: string description: The cause of the appointment being booked. https://www.datadictionary.nhs.uk/attributes/appointment_booked_reason.html appointmentBookedReasonLocalCode: type: string description: The cause of the appointment being booked. 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 attendanceStatus: type: string description: "An indication of whether the appointment occurred, whether\ \ the patient was late, whether the patient attended etc. https://www.datadictionary.nhs.uk/attributes/attendance_status.html" attendanceStatusCode: type: string description: "An indication of whether the appointment occurred, whether\ \ the patient was late, whether the patient attended etc. https://www.datadictionary.nhs.uk/attributes/attendance_status.html" attendanceStatusLocalCode: type: string description: "An indication of whether the appointment occurred, whether\ \ the patient was late, whether the patient attended etc." 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)" cancelledBy: type: string description: If appointment was cancelled by the patient or hospital. cancerPriorityOrdering: type: integer description: 0-5 ordering on priority where 0 is the highest priority - used by Cancer 360 to determine which records to preferentially display in the cancer PTL. Typically a static mapping with booking_status. 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." consultationMechanism: type: string description: The communication mechanism used to relay information between the care professional and patient. https://www.datadictionary.nhs.uk/attributes/consultation_mechanism.html consultationMechanismCode: type: string description: The communication mechanism used to relay information between the care professional and patient. https://www.datadictionary.nhs.uk/attributes/consultation_mechanism.html consultationMechanismLocalCode: type: string description: The communication mechanism used to relay information between the care professional and patient. 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 earliestClinicallyAppropriateDate: type: string description: The earliest date is clinically appropriate for the appointment to take place. https://www.datadictionary.nhs.uk/data_elements/earliest_clinically_appropriate_date.html format: date earliestReasonableOfferDate: type: string description: The date of the earliest of the reasonable offers made to the patient for the appointment. Comprehensive details of what constitutes a reasonable offer can be found in the data dictionary. https://www.datadictionary.nhs.uk/data_elements/earliest_reasonable_offer_date.html format: date endDateTime: type: string description: Appointment end date and time format: date-time hasDateInTheLastNDays: type: boolean description: "Is ordered_date, scheduled_date or attended_date \"recent\"\ , by default this means within the last 3 days" healthcareProvider: type: string description: The organisation acting as the healthcare provider for the appointment. https://www.datadictionary.nhs.uk/data_elements/organisation_identifier__code_of_provider_.html healthcareProviderOdsCode: type: string description: The organisation acting as the healthcare provider for the appointment. https://www.datadictionary.nhs.uk/data_elements/organisation_identifier__code_of_provider_.html isDateTimeBookedInTheLastNDays: type: boolean description: "Is date_time_booked \"recent\", by default this means within\ \ the last 3 days" isDateTimeCancelledInTheLastNDays: type: boolean description: "Is date_time_cancelled \"recent\", by default this means within\ \ the last 3 days" 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' isOrderedDateInTheLastNDays: type: boolean description: "Is ordered_date \"recent\", by default this means within the\ \ last 3 days" isPoaAppointment: type: boolean description: '`True` if the appointment is a pre-operative assessment' isStartDateTimeInTheLastNDays: type: boolean description: "Is start_date_time \"recent\", by default this means within\ \ the last 3 days" lastRefreshedAtSourceTimestamp: type: string description: Timestamp to be set when the data is calculated at source to indicate when this data was last refreshed (not the same as ingest timestamp) format: date-time latestClinicallyAppropriateDate: type: string description: "The latest date by which the patient should next be reviewed\ \ (includes follow-up consultation, investigation, or further management)\ \ in order to maintain a reasonable margin of clinical safety, as judged\ \ by the responsible care professional. https://www.datadictionary.nhs.uk/data_elements/latest_clinically_appropriate_date.html" format: date orderedDate: type: string description: The date that the appointment was ordered/requested format: date outcomeOfAttendance: type: string description: The outcome of the outpatient attendance. https://www.datadictionary.nhs.uk/attributes/outcome_of_attendance.html outcomeOfAttendanceCode: type: string description: The outcome of the outpatient attendance. https://www.datadictionary.nhs.uk/attributes/outcome_of_attendance.html outcomeOfAttendanceLocalCode: type: string description: The outcome of the outpatient attendance. pathwayId: type: string description: Foreign key to the pathway the appointment lies on. patientId: type: string description: The patient the appointment is scheduled for poaOutcome: type: string description: "DEPRECATED - use outcome_of_attendance instead. 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 nullable: true items: type: string sourceSystemNames: type: array description: String descriptors or display names of the source systems the data in this row is sourced from nullable: true 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: The specialty the patient is being treated for. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html treatmentFunctionLocalCode: type: string description: The specialty the patient is being treated for. treatmentFunctionName: type: string description: The specialty the patient is being treated for. 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)" wasPatientOnPifuPathway: type: boolean description: A boolean that's true when the patient was on a PIFU pathway at the date of appointment. https://www.datadictionary.nhs.uk/attributes/patient_on_patient_initiated_out-patient_follow_up_pathway_indicator.html wasPatientSubjectToRemoteMontitoring: type: boolean description: A boolean that's true when the patient was subject to remote monitoring at the date of appointment. https://www.datadictionary.nhs.uk/attributes/patient_subject_to_remote_monitoring_indicator.html description: "" Osdk.AppointmentProperties: type: string enum: - administrativeCategory - dateTimeCancelled - attendanceStatus - endDateTime - rvGroupIds - wasPatientOnPifuPathway - cancellationReason - cancerPriorityOrdering - bookedDuration - attendanceStatusCode - rttPeriodEndDate - orderedDate - isStartDateTimeInTheLastNDays - isFirstAppointment - appointmentBookedReasonLocalCode - hasDateInTheLastNDays - rttPeriodLength - patientId - code - attendanceId - treatmentFunctionName - administrativeCategoryCode - category - cancelledBy - appointmentFreeText - sourceSystemNames - attendanceStatusLocalCode - appointmentBookedReason - specialtyName - poaOutcome - startDateTime - isDateTimeBookedInTheLastNDays - isPoaAppointment - outcomeOfAttendance - isDateTimeCancelledInTheLastNDays - dateTimeBooked - pathwayId - priority - treatmentFunctionCode - healthcareProvider - rttPathwayStatus - outcomeOfAttendanceCode - specialtyId - earliestClinicallyAppropriateDate - consultationMechanism - latestClinicallyAppropriateDate - wasPatientSubjectToRemoteMontitoring - healthcareProviderOdsCode - consultationMechanismLocalCode - bookedBy - appointmentBookedReasonCode - bookingStatus - consultationMechanismCode - type - rttPeriodStartDate - administrativeCategoryLocalCode - clinicId - treatmentFunctionLocalCode - lastRefreshedAtSourceTimestamp - earliestReasonableOfferDate - isOrderedDateInTheLastNDays - outcomeOfAttendanceLocalCode - referralId Osdk.AssignedCareProfessional: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string appointmentId: type: string description: A foreign key to Appointment. assignedCareProfessionalId: type: string description: Primary key. careProfessionalId: type: string description: A foreign key to Care Professional. clinicalResponsibilityTimestamp: type: string description: The timestamp the care professional became clinically responsible for the patient. https://www.datadictionary.nhs.uk/nhs_business_definitions/care_professional_clinical_responsibility_timestamp.html format: date-time consultantEpisodeId: type: string description: A foreign key to Consultant Episode. isResponsibleCareProfessional: type: boolean description: A flag that indicates whether the care professional has overall clinical responsibility of the patient for the linked activity. https://www.datadictionary.nhs.uk/data_elements/responsible_care_professional_indicator.html isResponsibleForEdDischarge: type: boolean description: A flag that indicates whether the care professional is responsible for discharging the patient from an emergency department. https://www.datadictionary.nhs.uk/nhs_business_definitions/care_professional_clinical_responsibility_timestamp.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 nullable: true items: type: string uecAttendanceId: type: string description: A foreign key to UEC Attendance. description: "Links a care professional with an activity (Appointment, Consultant\ \ Episode, or ED Attendance)" Osdk.AssignedCareProfessionalProperties: type: string enum: - appointmentId - uecAttendanceId - clinicalResponsibilityTimestamp - careProfessionalId - rvGroupIds - isResponsibleForEdDischarge - consultantEpisodeId - isResponsibleCareProfessional - assignedCareProfessionalId Osdk.Birth: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string admissionId: type: string description: Foreign key to the Admission object type. babyPatientId: type: string description: Foreign key to the baby's Patient object type. birthId: type: string description: Primary key birthSequenceNumber: type: integer description: "The sequence in which the baby was born, with 1 being the\ \ first baby. This field is mostly useful for twins, triplets, etc. https://www.datadictionary.nhs.uk/data_elements/birth_order.html" birthWeightGrams: type: integer description: Weight of the baby in grams. Please map any value of 9999 (unknown weight) to null. https://www.datadictionary.nhs.uk/data_elements/birth_weight.html deliveryMethod: type: string description: The method by which the baby was delivered. https://www.datadictionary.nhs.uk/attributes/delivery_method.html deliveryMethodCode: type: string description: The method by which the baby was delivered. https://www.datadictionary.nhs.uk/attributes/delivery_method.html deliveryMethodLocalCode: type: string description: The method by which the baby was delivered. gestationLengthWeeks: type: integer description: The number of weeks completed gestation. https://www.datadictionary.nhs.uk/attributes/gestation_length_in_weeks.html isStillBirth: type: boolean description: A boolean that is true if the birth was a still birth. labourId: type: string description: Foreign key to the mother's labour that led to the birth. liveOrStillBirth: type: string description: "If the birth is a still birth, this will discern the type\ \ of still birth e.g. \"Stillbirth ante-partum\". If the birth was not\ \ a still birth, the value will be \"Live\". https://www.datadictionary.nhs.uk/attributes/live_or_still_birth.html" liveOrStillBirthCode: type: string description: "The type of still birth, or live birth. https://www.datadictionary.nhs.uk/attributes/live_or_still_birth.html" liveOrStillBirthLocalCode: type: string description: Indicates whether the birth is live or still birth. pregnancyId: type: string description: Foreign key to the mother's pregnancy. resuscitationMethod: type: string description: The method used to resuscitate the baby. https://www.datadictionary.nhs.uk/attributes/resuscitation_method_code.html resuscitationMethodCode: type: string description: The method used to resuscitate the baby. https://www.datadictionary.nhs.uk/attributes/resuscitation_method_code.html resuscitationMethodLocalCode: type: string description: The method used to resuscitate the baby. 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 nullable: true items: type: string statusOfPersonConductingDelivery: type: string description: "The type of person conducting the delivery e.g. midwife, hospital\ \ doctor etc. https://www.datadictionary.nhs.uk/attributes/status_of_person_conducting_delivery.html" statusOfPersonConductingDeliveryCode: type: string description: The type of person conducting the delivery. https://www.datadictionary.nhs.uk/attributes/status_of_person_conducting_delivery.html statusOfPersonConductingDeliveryLocalCode: type: string description: The type of person conducting the delivery. description: The details of the birth event. Osdk.BirthProperties: type: string enum: - statusOfPersonConductingDelivery - gestationLengthWeeks - pregnancyId - liveOrStillBirth - deliveryMethod - rvGroupIds - birthSequenceNumber - liveOrStillBirthLocalCode - liveOrStillBirthCode - resuscitationMethodLocalCode - isStillBirth - birthId - birthWeightGrams - labourId - statusOfPersonConductingDeliveryLocalCode - admissionId - resuscitationMethodCode - deliveryMethodCode - babyPatientId - statusOfPersonConductingDeliveryCode - deliveryMethodLocalCode - resuscitationMethod Osdk.BookingRequest: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string action: type: string description: Booking action required amPm: type: string description: Whether the booking is morning/afternoon/all day (values - AM / PM / AD) assignedTeamId: type: string description: ID of the team assigned to this task assignedTeamName: type: string description: Name of assigned team of this task assignedUserGroup: type: string description: User group responsible for booking request assignedUserIds: type: array description: IDs of users assigned to this task nullable: true items: type: string bookingRequestId: type: string description: ID of booking request closedAt: type: string description: Timestamp when this task was closed format: date-time closedBy: type: string description: User who closed this task comment: type: string description: Booking request comment consultantId: type: string description: Encounter lead consultant date: type: string description: Date of the booking format: date encounterEstimatedTotalTheatreTime: type: integer description: Estimated total theatre time of the encounter encounterId: type: string description: "Foreign key: encounter" intendedPrimaryProcedureDescription: type: string description: Description of the intended primary procedure intendedPrimaryProcedureFreeText: type: string description: Free-text description of the intended primary procedure mnemonic: type: string description: Mnemonic used to identify the booking mrn: type: string description: Patient MRN personId: type: string description: "ID, a unique identifier for each patient" reason: type: string description: Booking request reason specialtyId: type: string description: Associated encounter specialty status: type: string description: "Status of booking request (Open, Completed, Declined, Pending)" taskDueDate: type: string description: Due date for this task format: date taskPriority: type: string description: "High, Medium, or Low" taskType: type: string description: Task type - this will always be 'Inpatient Booking Request' tciTimestamp: type: string description: To come in - timestamp format: date-time theatreBookingId: type: string description: ID of the associated theatre booking theatreName: type: string description: Name of the theatre theatreSessionId: type: string description: Associated theatre session theatreSessionPlannedDurationMinutes: type: integer description: Duration of the planned theatre session theatreSessionPrimaryConsultantId: type: string description: ID of the primary consultant timestamp: type: string description: Timestamp booking request created format: date-time title: type: string description: Booking request title type: type: string description: "Booking request type (Book, Move, Cancel)" updatedAt: type: string description: Timestamp when this task was most recently updated format: date-time updatedBy: type: string description: User who most recently updated this task userId: type: string description: Multipass user id of user creating booking request Osdk.BookingRequestComment: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string bookingRequestId: type: string description: Booking request commentAction: type: string description: Action taken when creating comment commentId: type: string description: ID of comment commentMarkdown: type: string description: Markdown version of free text comment commentText: type: string description: String text of comment commentTimestamp: type: string description: Timestamp when comment was created format: date-time commentUser: type: string description: multipass user-id of user creating comment tags: type: array description: Tags of comment nullable: true items: type: string Osdk.BookingRequestCommentProperties: type: string enum: - bookingRequestId - commentMarkdown - commentText - tags - commentAction - commentTimestamp - commentId - commentUser Osdk.BookingRequestProperties: type: string enum: - closedAt - theatreBookingId - updatedBy - theatreSessionPlannedDurationMinutes - userId - status - taskPriority - mrn - tciTimestamp - intendedPrimaryProcedureDescription - specialtyId - taskType - assignedTeamName - theatreSessionPrimaryConsultantId - personId - amPm - assignedUserIds - reason - date - type - updatedAt - consultantId - action - assignedUserGroup - encounterEstimatedTotalTheatreTime - title - comment - closedBy - timestamp - intendedPrimaryProcedureFreeText - bookingRequestId - taskDueDate - encounterId - mnemonic - assignedTeamId - theatreName - theatreSessionId Osdk.CancerPathway: required: - __apiName - __primaryKey type: object properties: _24DayBreachDate: type: string description: The date by which the the treating provider should start treatment after receiving a referral from the diagnosing provider. format: date _28DayBreachDate: type: string description: The date by which the 28-day faster diagnosis standard for diagnosis or ruling out cancer is breached. This is the date after which the patient was not informed of their diagnosis within the 28-day Faster Diagnosis Standard. format: date _31DayBreachDate: type: string description: The date by which the 31-day faster diagnosis standard from decision to treat to first treatment is breached. This is the date after which the patient did not receive their first treatment within the 31-day standard. format: date _62DayBreachDate: type: string description: The date by which the 62-day faster diagnosis standard from urgent referral to first treatment is breached. This is the date after which the patient did not receive their first treatment within the 62-day standard. format: date __apiName: type: string __primaryKey: type: string __rid: type: string adjustedPathwayStartDate: type: string description: The start date of the cancer pathway after taking into account any adjustments. This date is used to calculate waiting times and may be adjusted for valid reasons like patient choice or clinical necessity. format: date birthDate: type: string description: The patient's date of birth. format: date cancerPathwayId: type: string description: The primary key for the cancer pathway. cancerSite: type: string description: "The primary site of cancer, such as breast, lung, or colorectal." cancerSubSite: type: string description: A more specific location within the primary cancer site. daysSinceAdjustedPathwayStart: type: integer description: The number of days since the pathway started. daysSinceAdjustedPathwayStartBucket: type: string description: "String representation of the days since adjusted pathway start\ \ column. One of: null, 0-28, 29-62, 63+" deathDate: type: string description: "The date of the patient's death, if applicable." format: date decisionToTreatDate: type: string description: The date on which a clinical decision to treat was made regarding the patient's treatment plan. format: date diagnosis: type: string description: The medical diagnosis of the patient's cancer. diagnosisDate: type: string description: The date on which the cancer diagnosis was confirmed. format: date diagnosisIcd10Code: type: string description: The ICD-10 code corresponding to the cancer diagnosis. firstName: type: string description: The patient's first name. firstSeenDate: type: string description: The date on which the patient was first seen by a specialist. This can be the first outpatient appointment or the first diagnostic test that leads to the diagnosis. format: date firstSeenSite: type: string description: The name of the organization where the patient is first seen. firstSeenSiteOdsCode: type: string description: The ODS code of the organization where the patient is first seen. firstTreatmentDate: type: string description: The date on which the patient received their first definitive treatment for cancer. format: date firstTreatmentType: type: string description: The type of treatment used for the first_treatment milestone on the pathway. fullName: type: string description: The patient's full name. hospitalSite: type: string description: The name of the hospital site. hospitalSiteId: type: string description: id of the hospital site. is28DayPathwayOpen: type: boolean description: Indicator of whether the 28 day faster diagnosis standard cancer pathway is open. is31DayPathwayOpen: type: boolean description: Indicator of whether the 31 day faster diagnosis standard cancer pathway is open. is62DayPathwayOpen: type: boolean description: Indicator of whether the 62 day cancer faster diagnosis standard pathway is open. isAnyPathwayTypeOpen: type: boolean description: "True if any of 28, 31 or 62 pathways are open." isBenign: type: boolean description: Whether the diagnosis is benign. lastRefreshedAtSourceTimestamp: type: string description: The date and time that this row of data was last refreshed at from the source system. format: date-time mrn: type: string description: Medical record number/hospital number. nhsNumber: type: string description: "NHS number, National-level identifier for a patient https://www.datadictionary.nhs.uk/attributes/nhs_number.html" organisationSiteTreatment: type: string description: The ORGANISATION SITE IDENTIFIER of the organization where the patient receives treatment. originalPathwayStartDate: type: string description: "The initial start date of the cancer pathway, typically the\ \ date the urgent referral was received." format: date pathwayClosedDate: type: string description: "The date on which the cancer pathway was closed, either because\ \ treatment was completed, the patient was diagnosed as benign, or the\ \ patient left the pathway for another reason." format: date pathwayStatus: type: string description: "The current status of the cancer pathway (e.g., Open, Closed)." pathwayType: type: string description: "The type of cancer pathway (e.g. urgent suspected cancer [62\ \ day standard], breast symptomatic, screening, upgrade)." patientId: type: string description: Foreign key to the patient on this pathway. patientInformedDate: type: string description: The date on which the patient was informed about their diagnosis or treatment plan. format: date referralReceivedDate: type: string description: The date on which the referral was received by the hospital. This marks the start of the cancer pathway clock. format: date referralSource: type: string description: "The source of the referral, identifying who referred the 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 nullable: true items: type: string rvModules: type: array description: Deprecated property formerly used to set permissions nullable: true items: type: string sourceSystemNames: type: array description: String descriptor or display names of the source systems the data in this row is sourced from nullable: true items: type: string surname: type: string description: The patient's surname. title: type: string description: "Title string representing the pathway. Concatenation of patient\ \ name, mrn, cancer site and days since adjusted pathway start." treatmentSite: type: string description: The name of the organization where the patient receives treatment. treatmentSiteOdsCode: type: string description: The ODS code of the organization where the patient receives treatment. treatmentType: type: string description: The type of treatment upgradeDate: type: string description: The date that the consultant responsible for the care of the patient (or an authorized member of the consultant team) decided that the patient should be upgraded from an RTT period to a 62-day period as cancer is suspected. format: date waitingTimeAdjustmentDays: type: integer description: "Adjustment, in days, made to the pathway start date. Could\ \ be due to many factors, such as patient delays or clinical reasons." description: "" Osdk.CancerPathwayProperties: type: string enum: - firstSeenSite - treatmentSite - upgradeDate - rvGroupIds - fullName - mrn - daysSinceAdjustedPathwayStart - surname - daysSinceAdjustedPathwayStartBucket - pathwayType - _24DayBreachDate - decisionToTreatDate - patientId - pathwayStatus - treatmentSiteOdsCode - originalPathwayStartDate - referralSource - sourceSystemNames - adjustedPathwayStartDate - isBenign - pathwayClosedDate - hospitalSiteId - diagnosisDate - diagnosisIcd10Code - is28DayPathwayOpen - nhsNumber - _31DayBreachDate - diagnosis - birthDate - firstTreatmentType - hospitalSite - organisationSiteTreatment - _62DayBreachDate - isAnyPathwayTypeOpen - rvModules - patientInformedDate - cancerSite - _28DayBreachDate - cancerPathwayId - waitingTimeAdjustmentDays - cancerSubSite - title - is62DayPathwayOpen - firstName - firstTreatmentDate - firstSeenSiteOdsCode - lastRefreshedAtSourceTimestamp - firstSeenDate - treatmentType - referralReceivedDate - deathDate - is31DayPathwayOpen Osdk.CancerTrackingComment: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string cancerPathwayId: type: string description: The foreign key for the cancer pathway this comment is about. cancerTrackingCommentId: type: string description: The primary key for the cancer tracking comment. commentText: type: string description: The text content of the comment. commentTitle: type: string description: The title or subject of the comment. createdAtTimestamp: type: string description: The timestamp indicating when the comment was created. format: date-time createdBy: type: string description: The unique identifier for the patient's cancer pathway associated with the comment. dueDate: type: string description: "Date of the action due (only applicable if type = action,\ \ otherwise null)" format: date isLatest: type: boolean description: True if the created_at_timestamp column is the most recent value grouped by cancer_pathway_id lastRefreshedAtSourceTimestamp: type: string description: The date and time that this row of data was last refreshed at from the source system. format: date-time 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 nullable: true items: type: string rvModules: type: array description: Deprecated property formerly used to set permissions nullable: true items: type: string sourceSystemNames: type: array description: String descriptors or display names of the source systems the data in this row is sourced from nullable: true items: type: string status: type: string description: "Status of the action, e.g. open, closed, etc, (only required\ \ if type = action)" type: type: string description: "The type of the comment, for example comment or action" description: "" Osdk.CancerTrackingCommentProperties: type: string enum: - rvModules - cancerPathwayId - type - status - rvGroupIds - createdBy - createdAtTimestamp - sourceSystemNames - dueDate - commentTitle - lastRefreshedAtSourceTimestamp - cancerTrackingCommentId - commentText - isLatest Osdk.CancerTreatment: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string attendedDate: type: string description: The date on which the treatment was attended. format: date cancerPriorityOrdering: type: integer description: 0-5 ordering on priority where 0 is the highest priority - used by Cancer 360 to determine which records to preferentially display in the cancer PTL. Typically a static mapping with clean_status. cancerTreatmentId: type: string description: The primary key for the treatment. cleanTreatmentStatus: type: string description: "The status of this treatment. One of ordered, scheduled, attended,\ \ cancelled, did not attend to be calculated/derived based on the data\ \ available at the local trust" hasDateInTheLastNDays: type: boolean description: "Is attended_date, ordered_date or scheduled_date \"recent\"\ , by default this means within the last 3 days" isAttendedDateInTheLastNDays: type: boolean description: "Is attended_date \"recent\", by default this means within\ \ the last 3 days" isOrderedDateInTheLastNDays: type: boolean description: "Is ordered_date \"recent\", by default this means within the\ \ last 3 days" isScheduledDateInTheLastNDays: type: boolean description: "Is scheduled_date \"recent\", by default this means within\ \ the last 3 days" lastRefreshedAtSourceTimestamp: type: string description: The timestamp indicating when the data was last refreshed at the source. format: date-time orderedDate: type: string description: The date on which the treatment was ordered. format: date patientId: type: string description: Foreign key to the patient receiving the treatment. 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 nullable: true items: type: string rvModules: type: array description: Deprecated property formerly used to set permissions nullable: true items: type: string scheduledDate: type: string description: The date on which the treatment was scheduled. format: date sourceSystemNames: type: array description: String descriptors or display names of the source systems the data in this row is sourced from nullable: true items: type: string treatmentDescription: type: string description: A description of the treatment provided. treatmentStatus: type: string description: The current raw status of the treatment. treatmentType: type: string description: The type of treatment administered. description: "" Osdk.CancerTreatmentProperties: type: string enum: - rvModules - cancerTreatmentId - patientId - cleanTreatmentStatus - rvGroupIds - attendedDate - cancerPriorityOrdering - sourceSystemNames - isScheduledDateInTheLastNDays - treatmentStatus - lastRefreshedAtSourceTimestamp - isAttendedDateInTheLastNDays - treatmentType - scheduledDate - orderedDate - isOrderedDateInTheLastNDays - treatmentDescription - hasDateInTheLastNDays Osdk.CareProfessional: required: - __apiName - __primaryKey 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 nullable: true items: type: string mainSpecialty: type: string description: The main specialty the consultant is contracted under for the trust. https://www.datadictionary.nhs.uk/attributes/main_specialty_code.html mainSpecialtyCode: type: string description: Data dictionary code. The main specialty the consultant is contracted under for the trust. https://www.datadictionary.nhs.uk/attributes/main_specialty_code.html name: type: string description: "Care Professional name (Last Name, First Name)" professionalRegistrationBody: type: string description: The professional registration body responsible for issuing the professional registration entry identifier. https://www.datadictionary.nhs.uk/attributes/professional_registration_body_code.html professionalRegistrationBodyCode: type: string description: Data dictionary code. The professional registration body responsible for issuing the professional registration entry identifier. https://www.datadictionary.nhs.uk/attributes/professional_registration_body_code.html professionalRegistrationEntryId: type: string description: The identifier issued to a registered care professional by the professional registration body. https://www.datadictionary.nhs.uk/attributes/professional_registration_entry_identifier.html 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 nullable: true items: type: string Osdk.CareProfessionalProperties: type: string enum: - careProfessionalLocalId - professionalRegistrationEntryId - role - localSubSpecialties - professionalRegistrationBody - name - professionalRegistrationBodyCode - careProfessionalId - rvGroupIds - isActive - mainSpecialty - mainSpecialtyCode Osdk.CareService: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string careServiceId: type: string createdAt: type: string format: date-time createdBy: type: string description: type: string modules: type: array nullable: true items: type: string name: type: string status: type: string updatedAt: type: string format: date-time updatedBy: type: string description: "" Osdk.CareServiceProperties: type: string enum: - updatedBy - name - updatedAt - modules - status - description - createdBy - careServiceId - createdAt Osdk.CdmModulePermissioning: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string moduleGroupIds: type: array nullable: true items: type: string moduleName: type: string description: Configure the groups which can see data associated with each module Osdk.CdmModulePermissioningProperties: type: string enum: - moduleGroupIds - moduleName Osdk.CdmObjectPermissioning: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string modules: type: array nullable: true items: type: string objectGroupIds: type: array nullable: true items: type: string objectId: type: string objectName: type: string description: "" Osdk.CdmObjectPermissioningProperties: type: string enum: - modules - objectId - objectName - objectGroupIds Osdk.CdmPathwayComment: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string commentStatus: type: string description: "Status of the comment (i.e Add comment, Delete comment)" commentText: type: string description: String text of comment commentType: type: string description: Subject of the comment being created createdAt: type: string description: Timestamp when comment was created format: date-time createdBy: type: string description: multipass user-id of user creating comment pathwayCommentId: type: string description: ID of comment pathwayId: type: string description: The unique identifier of the pathway that corresponds to this comment. https://www.datadictionary.nhs.uk/attributes/patient_pathway_identifier.html source: type: string description: The source of the comment e.g User Entry (only written when actions taken in the RTT Tool) or PAS updatedAt: type: string description: Timestamp when comment was updated format: date-time updatedBy: type: string description: multipass user-id of user updating the comment description: "" Osdk.CdmPathwayCommentProperties: type: string enum: - pathwayId - updatedBy - source - commentText - commentStatus - updatedAt - createdBy - commentType - pathwayCommentId - createdAt Osdk.CdmTeam: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string cancerSites: type: array description: The names of the cancer sites this team is liked to. Leave empty if not relevant. nullable: true items: type: string careServiceId: type: string description: The id of the Care Service this Team sits under. createdAt: type: string format: date-time createdBy: type: string description: type: string locationIds: type: array description: The ids of the locations that the team is linked to nullable: true items: type: string modules: type: array description: "String array of modules this team is relevant to, e.g. cancer,\ \ outpatient, rtt, inpatient, optica" nullable: true items: type: string name: type: string siteIds: type: array nullable: true items: type: string siteNames: type: array description: The names of the sites that the team is linked to nullable: true items: type: string specialties: type: array nullable: true items: type: string status: type: string description: "The status of the team, one of: Active, Staging, Deprecated" teamId: type: string teamTypes: type: array nullable: true items: type: string updatedAt: type: string format: date-time updatedBy: type: string description: "" Osdk.CdmTeamMember: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string band: type: string createdAt: type: string format: date-time createdBy: type: string jobTitle: type: string updatedAt: type: string format: date-time updatedBy: type: string userId: type: string description: "" Osdk.CdmTeamMemberProperties: type: string enum: - updatedBy - userId - updatedAt - createdBy - band - createdAt - jobTitle Osdk.CdmTeamMembership: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string createdAt: type: string format: date-time createdBy: type: string roles: type: array nullable: true items: type: string teamId: type: string teamMembershipId: type: string updatedAt: type: string format: date-time updatedBy: type: string userId: type: string description: This object captures the many to many relationship between teams and members Osdk.CdmTeamMembershipProperties: type: string enum: - updatedBy - teamMembershipId - userId - updatedAt - createdBy - teamId - createdAt - roles Osdk.CdmTeamProperties: type: string enum: - updatedBy - locationIds - name - modules - updatedAt - siteNames - status - createdBy - careServiceId - teamId - createdAt - specialties - teamTypes - cancerSites - description - siteIds Osdk.ChangeLogRequest: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string actionType: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserIds: type: array nullable: true items: type: string careProfessionalId: type: string careProfessionalName: type: string changeLogId: type: string closedAt: type: string format: date-time closedBy: type: string description: type: string ealId: type: string encounterId: type: string freeTextComments: type: string isRTT: type: boolean newValue: type: string originatingWaitingListAlertRuleIds: type: array nullable: true items: type: string originatingWaitingListAlertRuleTypes: type: array nullable: true items: type: string preResolved: type: boolean primaryEvidenceSource: type: string propertyToModify: type: string rcsClinicalHarmReview: type: string requestedBy: type: string resolved: type: boolean secondaryEvidenceSource: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string taskDueDate: type: string format: date taskPriority: type: string taskType: type: string timestamp: type: string format: date-time Osdk.ChangeLogRequestProperties: type: string enum: - closedAt - changeLogId - newValue - originatingWaitingListAlertRuleIds - taskPriority - ealId - specialtyId - actionType - taskType - assignedTeamName - propertyToModify - originatingWaitingListAlertRuleTypes - description - freeTextComments - requestedBy - assignedUserIds - preResolved - careProfessionalId - closedBy - timestamp - isRTT - specialtyName - careProfessionalName - secondaryEvidenceSource - taskDueDate - encounterId - resolved - assignedTeamId - primaryEvidenceSource - rcsClinicalHarmReview Osdk.ClinicLetter: required: - __apiName - __primaryKey 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 hasLetterContent: type: boolean description: Whether this letter object has the full text content or not letterContent: type: string description: The full text content of the letter letterRid: $ref: "#/components/schemas/Core.MediaReference" 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 nullable: true items: type: string specialtyId: type: string description: Id of the specialty for the linked appointment specialtyName: type: string description: Specialty for the linked appointment status: type: string description: "The lifecycle stage of the clinic letter (e.g., Awaiting Signoff,\ \ Completed)." description: Metadata relating to clinic letters Osdk.ClinicLetterProperties: type: string enum: - patientId - letterContent - status - rvGroupIds - consultantId - letterRid - specialtyId - appointmentId - specialtyName - clinicLetterType - clinicLetterDate - clinicLetterId - hasLetterContent Osdk.ClinicSession: required: - __apiName - __primaryKey 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" cancellationReason: type: string description: "Reason of the cancellation (e.g. annual leave, study leave,\ \ industrial action, etc.)" cancellationTimestamp: type: string description: Date and time the clinic was cancelled format: date-time 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. clinicDisplayName: type: string description: Provides ability for Trusts to configure the way the clinic is diplayed in the front-end 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 clinicModality: type: string description: "Modality of the clinic (Face-to-face, Virtual, Tele-med)" 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 clinicUtilisation: type: number description: Percentage of available slot capacity booked format: double clinicUtilisationRag: type: string description: Used to specify colour rendering for the `clinic_utilisation` value in frontend applications. Default values (> 1.0 Red | >= 0.95 Green | >= 0.60 Orange | < 0.60 Red) date: type: string description: Date of clinic session format: date 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' leadConsultant: type: string description: The name of the lead consultant for the clinic leadConsultantId: type: string description: The id of the care professional who is the lead consultant for the clinic session 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 nullable: true 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 nullable: true items: type: string slotUtilisationPercentage: type: number description: Percentage of available slot capacity booked. Derived by default as total_booked_slots / total_slots format: double slotUtilisationRag: type: string description: Used to specify colour rendering for the `slot_utilisation` value in frontend applications. Default values (> 1.0 Red | >= 0.95 Green | >= 0.60 Orange | < 0.60 Red) specialtyId: type: string description: Primary Specialty of the clinic specialtyName: type: string description: the name of the 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 nullable: true items: type: string treatmentFunctionNames: type: array description: The corresponding name of the treatment function. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html nullable: true items: type: string type: type: string description: "The type of clinic e.g. pre-op, face-to-face" 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: "" Osdk.ClinicSessionProperties: type: string enum: - clinicDisplayName - location - rvGroupIds - cancellationReason - clinicFreeText - cancellationTimestamp - clinicModality - totalVacantSlots - weekDeltaStringDetails - overbooked - clinicUtilisation - roomId - hasAnnualLeave - slotSpecialtyIds - totalBookedSlots - careProfessionalId - siteName - isPrivate - treatmentFunctionNames - totalBookedDuration - specialtyName - totalVacantSlotDuration - statusReason - totalSlots - isCancelled - leadConsultantId - status - totalDuration - slotUtilisationPercentage - clinicCode - weekDelta - clinicEndTimestamp - specialtyId - leadConsultant - startDayOfWeek - totalVacantSlotsFollowup - siteId - bookingTeam - clinicTypeName - amPm - totalVacantSlotsNew - clinicTypeActive - date - treatmentFunctionCodes - type - clinicUtilisationRag - slotUtilisationRag - clinicId - clinicStartTimestamp - clinicName - weekDeltaString - clinicTypeId - hasAnnualLeaveString Osdk.ClinicSlot: required: - __apiName - __primaryKey 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 nullable: true items: type: string serviceIds: type: array nullable: true 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. ' Osdk.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 Osdk.ClinicType: required: - __apiName - __primaryKey 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. clinicTypeId: type: string description: Unique Identifier of the clinic type. 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 nullable: true items: type: string specialtyId: type: string description: ID of the specialty that runs clinic of this type. description: "" Osdk.ClinicTypeProperties: type: string enum: - clinicTypeActive - clinicTypeId - rvGroupIds - clinicTypeName - specialtyId Osdk.Comorbidity: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string comorbidity: type: string description: The comorbidity description. comorbidityIcd10Code: type: string description: The comorbidity ICD-10 code. comorbidityId: type: string description: Primary key. comorbiditySnomedCtCode: type: string description: The comorbidity SNOMED CT code. https://www.datadictionary.nhs.uk/data_elements/comorbidity__snomed_ct_.html patientId: type: string description: Foreign key to the patient who has these comorbidities. recordedEndDate: type: string description: The date the patient was recorded to not have this particular comorbidity. format: date recordedStartDate: type: string description: The date the patient was recorded to have this particular comorbidity. 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 nullable: true items: type: string description: "A medical condition that the patient lives with, which coexists\ \ with their main condition. https://www.datadictionary.nhs.uk/data_elements/comorbidity__snomed_ct_.html" Osdk.ComorbidityProperties: type: string enum: - comorbidityIcd10Code - patientId - recordedEndDate - comorbidity - recordedStartDate - rvGroupIds - comorbiditySnomedCtCode - comorbidityId Osdk.ConsultantEpisode: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string admissionId: type: string description: A foreign key to the Admission object type. consultantEpisodeExternalId: type: string description: The external identifier for the Consultant Episode. This should not be used as a foreign key. consultantEpisodeId: type: string description: Primary key. consultantEpisodeSequenceNumber: type: integer description: "The ordering of this consultant episode, relative to every\ \ other consultant episode in the admission/spell. For example, a sequence\ \ number of 1 means that it is the first consultant episode in the admission/spell.\ \ It can be between 1 to 87. 98 represents 'Not applicable' and 99 represents\ \ 'episode number not known'. https://www.datadictionary.nhs.uk/data_elements/episode_number.html" endTimestamp: type: string description: The timestamp when the consultant episode ended. format: date-time healthcareProvider: type: string description: The organisation acting as the healthcare provider for the consultant episode. https://www.datadictionary.nhs.uk/data_elements/organisation_identifier__code_of_provider_.html healthcareProviderOdsCode: type: string description: The organisation acting as the healthcare provider for the consultant episode. Where no organisation identifier has been issued for a non-uk provider then this is represented by 89997. Where no organisation identifier has been issued for a non-nhs uk porivder then this is represented by 89999. https://www.datadictionary.nhs.uk/data_elements/organisation_identifier__code_of_provider_.html patientId: type: string description: A foreign key to the Patient object type. psychiatricPatientStatus: type: string description: An indication of whether the patient has been admitted or transferred to a consultant in one of the psychiatric specialties within a previous admission. https://www.datadictionary.nhs.uk/attributes/psychiatric_patient_status.html psychiatricPatientStatusCode: type: string description: An indication of whether the patient has been admitted or transferred to a consultant in one of the psychiatric specialties within a previous admission. https://www.datadictionary.nhs.uk/attributes/psychiatric_patient_status.html psychiatricPatientStatusLocalCode: type: string description: An indication of whether the patient has been admitted or transferred to a consultant in one of the psychiatric specialties within a previous admission. rehabilitationAssessmentTeamType: type: string description: "An indication of whether the care professional team undertaking\ \ a rehabilitation assessment, is specialised or non-specialised. https://www.datadictionary.nhs.uk/data_elements/rehabilitation_assessment_team_type.html" rehabilitationAssessmentTeamTypeCode: type: string description: "An indication of whether the care professional team undertaking\ \ a rehabilitation assessment, is specialised or non-specialised. https://www.datadictionary.nhs.uk/data_elements/rehabilitation_assessment_team_type.html" rehabilitationAssessmentTeamTypeLocalCode: type: string description: "An indication of whether the care professional team undertaking\ \ a rehabilitation assessment, is specialised or non-specialised." 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 nullable: true items: type: string startTimestamp: type: string description: The timestamp when the consultant episode started. format: date-time totalNumberOfRehabilitationDays: type: integer description: The total number of days the patient spent under rehabilitation throughout the consultant episode. https://www.datadictionary.nhs.uk/data_elements/length_of_stay_adjustment__rehabilitation_.html totalNumberOfSpecialistPalliativeCareDays: type: integer description: The total number of days the patient spent under specialist palliative care throughout the consultant episode. https://www.datadictionary.nhs.uk/data_elements/length_of_stay_adjustment__specialist_palliative_care_.html treatmentFunction: type: string description: The specialty the patient is being treated for. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html treatmentFunctionCode: type: string description: The specialty the patient is being treated for. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html description: The period of time a particular consultant is in charge of a patient's care during an admission (spell). https://www.datadictionary.nhs.uk/nhs_business_definitions/consultant_episode__hospital_provider_.html Osdk.ConsultantEpisodeProperties: type: string enum: - rehabilitationAssessmentTeamTypeCode - patientId - treatmentFunctionCode - psychiatricPatientStatus - rvGroupIds - endTimestamp - consultantEpisodeId - healthcareProvider - psychiatricPatientStatusCode - rehabilitationAssessmentTeamType - rehabilitationAssessmentTeamTypeLocalCode - startTimestamp - consultantEpisodeExternalId - admissionId - treatmentFunction - consultantEpisodeSequenceNumber - totalNumberOfRehabilitationDays - totalNumberOfSpecialistPalliativeCareDays - healthcareProviderOdsCode - psychiatricPatientStatusLocalCode Osdk.CriticalCareDailySummary: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string criticalCareActivities: type: array description: A list of the activities (chargable services) that occurred to the patient during the day of critical care. https://www.datadictionary.nhs.uk/attributes/critical_care_activity_code.html nullable: true items: type: string criticalCareActivityCodes: type: array description: A list of the activities (chargable services) that occurred to the patient during the day of critical care. https://www.datadictionary.nhs.uk/attributes/critical_care_activity_code.html nullable: true items: type: string criticalCareActivityLocalCodes: type: array description: A list of the activities (chargable services) that occurred to the patient during the day of critical care. nullable: true items: type: string criticalCareDailySummaryDate: type: string description: The date of the critical care daily summary. format: date criticalCareDailySummaryId: type: string description: Primary key. criticalCareLevel: type: string description: "The level of critical care provided. Ranges from 0 to 3, with\ \ level 3 being the most intensive level of critical care; look at the\ \ data dictionary and national codes for more information. https://www.datadictionary.nhs.uk/attributes/critical_care_level.html" criticalCareLevelCode: type: string description: "The level of critical care provided. Ranges from 0 to 3, with\ \ level 3 being the most intensive level of critical care; look at the\ \ data dictionary and national codes for more information. https://www.datadictionary.nhs.uk/attributes/critical_care_level.html" criticalCareLevelLocalCode: type: string description: The level of critical care provided. criticalCarePeriodId: type: string description: A foreign key to the Critical Care Period object type. highCostDrugOpcs4Codes: type: array description: A list of the high cost drugs used in the day of critical care. https://www.datadictionary.nhs.uk/data_elements/high_cost_drugs__opcs_.html nullable: true items: type: string highCostDrugs: type: array description: A list of the high cost drugs used in the day of critical care. https://www.datadictionary.nhs.uk/data_elements/high_cost_drugs__opcs_.html nullable: true items: type: string organSystemsSupported: type: array description: An array of all of the organ systems supported throughout the day. https://www.datadictionary.nhs.uk/attributes/organ_system_supported.html nullable: true items: type: string organSystemsSupportedCodes: type: array description: An array of all of the organ systems supported throughout the day. https://www.datadictionary.nhs.uk/attributes/organ_system_supported.html nullable: true items: type: string organSystemsSupportedLocalCodes: type: array description: An array of all of the organ systems supported throughout the day. nullable: true items: type: string patientWeightKg: type: number description: The patient's weight in kilograms. https://www.datadictionary.nhs.uk/data_elements/person_weight.html format: double 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 nullable: true items: type: string description: Describes what happened to a patient on a particular day in critical care. Osdk.CriticalCareDailySummaryProperties: type: string enum: - criticalCareDailySummaryId - criticalCareLevelLocalCode - organSystemsSupportedCodes - criticalCarePeriodId - patientWeightKg - rvGroupIds - criticalCareLevel - organSystemsSupported - criticalCareDailySummaryDate - organSystemsSupportedLocalCodes - criticalCareActivityCodes - highCostDrugOpcs4Codes - criticalCareLevelCode - criticalCareActivityLocalCodes - highCostDrugs - criticalCareActivities Osdk.CriticalCarePeriod: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string admissionId: type: string description: A foreign key to the Admission object type. criticalCareAdmissionSource: type: string description: The type of organisation (primary) that the patient has been admitted from prior to the start of the critical care period. https://www.datadictionary.nhs.uk/attributes/critical_care_admission_source.html criticalCareAdmissionSourceCode: type: string description: The type of organisation (primary) that the patient has been admitted from prior to the start of the critical care period. https://www.datadictionary.nhs.uk/attributes/critical_care_admission_source.html criticalCareAdmissionSourceLocalCode: type: string description: The type of organisation (primary) that the patient has been admitted from prior to the start of the critical care period. criticalCareAdmissionType: type: string description: "An indication of whether the critical care period was initiated\ \ as a result of a non-emergency treatment plan, or not. https://www.datadictionary.nhs.uk/data_elements/critical_care_admission_type.html" criticalCareAdmissionTypeCode: type: string description: "An indication of whether the critical care period was initiated\ \ as a result of a non-emergency treatment plan, or not. https://www.datadictionary.nhs.uk/data_elements/critical_care_admission_type.html" criticalCareAdmissionTypeLocalCode: type: string description: "An indication of whether the critical care period was initiated\ \ as a result of a non-emergency treatment plan, or not." criticalCareDischargeDestination: type: string description: The primary organisation type that the patient has been discharged to at the end of the critical care period. https://www.datadictionary.nhs.uk/attributes/critical_care_discharge_destination.html criticalCareDischargeDestinationCode: type: string description: The primary organisation type that the patient has been discharged to at the end of the critical care period. https://www.datadictionary.nhs.uk/attributes/critical_care_discharge_destination.html criticalCareDischargeDestinationLocalCode: type: string description: The primary organisation type that the patient has been discharged to at the end of the critical care period. criticalCareDischargeLocation: type: string description: The type of location that the patient is discharged to at the end of the critical care period. https://www.datadictionary.nhs.uk/attributes/critical_care_discharge_location.html criticalCareDischargeLocationCode: type: string description: The type of location that the patient is discharged to at the end of the critical care period. https://www.datadictionary.nhs.uk/attributes/critical_care_discharge_location.html criticalCareDischargeLocationLocalCode: type: string description: The type of location that the patient is discharged to at the end of the critical care period. criticalCareDischargeStatus: type: string description: The status of the patient's discharge from critical care. https://www.datadictionary.nhs.uk/attributes/critical_care_discharge_status.html criticalCareDischargeStatusCode: type: string description: The status of the patient's discharge from critical care. https://www.datadictionary.nhs.uk/attributes/critical_care_discharge_status.html criticalCareDischargeStatusLocalCode: type: string description: The status of the patient's discharge from critical care. criticalCarePeriodId: type: string description: Primary key. criticalCarePeriodType: type: string description: "Whether the critical care period is for adults, paediatrics,\ \ or neonates." criticalCareSourceLocation: type: string description: The type of location the patient was in prior to the start of the critical care period. https://www.datadictionary.nhs.uk/attributes/critical_care_source_location.html criticalCareSourceLocationCode: type: string description: The type of location the patient was in prior to the start of the critical care period. https://www.datadictionary.nhs.uk/attributes/critical_care_source_location.html criticalCareSourceLocationLocalCode: type: string description: The type of location the patient was in prior to the start of the critical care period. criticalCareUnitFunction: type: string description: The principle type of critical care clinical service provided within the ward to which the patient was admitted during the critical care period. https://www.datadictionary.nhs.uk/attributes/critical_care_unit_function.html criticalCareUnitFunctionCode: type: string description: The principle type of critical care clinical service provided within the ward to which the patient was admitted during the critical care period. https://www.datadictionary.nhs.uk/attributes/critical_care_unit_function.html criticalCareUnitFunctionLocalCode: type: string description: The principle type of critical care clinical service provided within the ward to which the patient was admitted during the critical care period. dischargeTimestamp: type: string description: The timestamp the patient was discharged from critical care. format: date-time maxNumberOfOrganSystemsSupportedOnOneDay: type: integer description: The maximum number of organ systems supported on any one day during a critical care period. https://www.datadictionary.nhs.uk/attributes/organ_support_maximum.html patientId: type: string description: A foreign key to the Patient object type. readyForDischargeTimestamp: type: string description: "The date on which the patient has been declared clinically\ \ ready for discharge or transfer from critical care, and a formal request\ \ has been made to the hospital bed management system (or appropriate\ \ staff with authority to admit at the intended destination) and the date\ \ and time of this status is recorded as such in the clinical record.\ \ https://www.datadictionary.nhs.uk/attributes/critical_care_discharge_ready_date.html" format: date-time 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 nullable: true items: type: string startTimestamp: type: string description: The timestamp the critical care period started. format: date-time totalNumberOfAdvancedCardiovascularSupportDays: type: integer description: The total number of days that the patient received advanced cardiovascular support during the critical care period. https://www.datadictionary.nhs.uk/data_elements/advanced_cardiovascular_support_days.html totalNumberOfAdvancedRespiratorySupportDays: type: integer description: The total number of days that the patient received advanced respiratory support during the critical care period. https://www.datadictionary.nhs.uk/data_elements/advanced_respiratory_support_days.html totalNumberOfBasicCardiovascularSupportDays: type: integer description: The total number of days that the patient received basic cardiovascular support during the critical care period. https://www.datadictionary.nhs.uk/data_elements/basic_cardiovascular_support_days.html totalNumberOfBasicRespiratorySupportDays: type: integer description: The total number of days that the patient received basic respiratory support during the critical care period. https://www.datadictionary.nhs.uk/data_elements/critical_care_discharge_location.html totalNumberOfDermatologicalSupportDays: type: integer description: The total number of days that the patient received dermatological support during the critical care period. https://www.datadictionary.nhs.uk/data_elements/dermatological_support_days.html totalNumberOfGastrointestinalSupportDays: type: integer description: The total number of days that the patient received gastrointestinal support during the critical care period. https://www.datadictionary.nhs.uk/data_elements/gastro-intestinal_support_days.html totalNumberOfLevel2CareDays: type: integer description: The total number of days a patient received level 2 care during a critical care period. https://www.datadictionary.nhs.uk/data_elements/critical_care_level_2_days.html totalNumberOfLevel3CareDays: type: integer description: The total number of days a patient received level 3 care during a critical care period. https://www.datadictionary.nhs.uk/data_elements/critical_care_level_3_days.html totalNumberOfLiverSupportDays: type: integer description: The total number of days that the patient received liver support during the critical care period. https://www.datadictionary.nhs.uk/data_elements/liver_support_days.html totalNumberOfNeurologicalSupportDays: type: integer description: The total number of days that the patient received neurological support during the critical care period. https://www.datadictionary.nhs.uk/data_elements/neurological_support_days.html totalNumberOfRenalSupportDays: type: integer description: The total number of days that the patient received renal support during the critical care period. https://www.datadictionary.nhs.uk/data_elements/renal_support_days.html unitBedConfiguration: type: string description: The main composition of critical bed types for the ward. https://www.datadictionary.nhs.uk/data_elements/critical_care_unit_bed_configuration.html unitBedConfigurationCode: type: string description: The main composition of critical bed types for the ward. https://www.datadictionary.nhs.uk/data_elements/critical_care_unit_bed_configuration.html unitBedConfigurationLocalCode: type: string description: The main composition of critical bed types for the ward. description: A period of time within an admission/spell during which a patient receives critical care. https://www.datadictionary.nhs.uk/classes/critical_care_period.html Osdk.CriticalCarePeriodProperties: type: string enum: - criticalCareDischargeDestination - criticalCareUnitFunctionCode - totalNumberOfGastrointestinalSupportDays - criticalCareSourceLocation - dischargeTimestamp - criticalCarePeriodId - rvGroupIds - criticalCareSourceLocationLocalCode - maxNumberOfOrganSystemsSupportedOnOneDay - totalNumberOfLevel2CareDays - criticalCareAdmissionType - startTimestamp - totalNumberOfBasicRespiratorySupportDays - totalNumberOfBasicCardiovascularSupportDays - admissionId - criticalCareDischargeDestinationLocalCode - criticalCareDischargeDestinationCode - readyForDischargeTimestamp - totalNumberOfRenalSupportDays - totalNumberOfAdvancedCardiovascularSupportDays - totalNumberOfAdvancedRespiratorySupportDays - unitBedConfiguration - patientId - criticalCareDischargeStatusLocalCode - unitBedConfigurationCode - unitBedConfigurationLocalCode - criticalCareAdmissionSource - criticalCareUnitFunctionLocalCode - criticalCareDischargeStatus - criticalCareSourceLocationCode - criticalCareAdmissionTypeCode - totalNumberOfLevel3CareDays - totalNumberOfLiverSupportDays - criticalCareAdmissionSourceLocalCode - criticalCareDischargeLocation - criticalCareUnitFunction - criticalCareDischargeStatusCode - criticalCareAdmissionSourceCode - totalNumberOfNeurologicalSupportDays - criticalCareAdmissionTypeLocalCode - criticalCarePeriodType - criticalCareDischargeLocationCode - totalNumberOfDermatologicalSupportDays - criticalCareDischargeLocationLocalCode Osdk.DatasetRefreshTime: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string datasetName: type: string description: name of the dataset refreshed lastRefreshSource: type: string description: "source of last refresh i.e PAS, DWH, etc.." lastRefreshTimestamp: type: string description: last refresh timestamp format: date-time description: "" Osdk.DatasetRefreshTimeProperties: type: string enum: - lastRefreshSource - datasetName - lastRefreshTimestamp Osdk.DiagnosticsWaitlistEntry: required: - __apiName - __primaryKey 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 nullable: true 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 waitlist entries. Osdk.DiagnosticsWaitlistEntryProperties: type: string enum: - pathwayId - patientId - priority - diagnosticsWaitlistId - rvGroupIds - sixWeekBreachDate - diagnosticsDate - addedToWaitlistTimestamp - diagnosticsRequest - specialtyId Osdk.EMed3FitNote: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string admissionId: type: string description: Foreign key to the admission that issued the fit note. applicablePeriodDurationDays: type: integer description: "The number of days for which the fit note is applicable. This\ \ is the period of time from when the fit note has been issued, until\ \ the fit note end date. https://www.datadictionary.nhs.uk/data_elements/emed3_fit_note_duration.html" appointmentId: type: string description: Foreign key to the appointment that issued the fit note. assessmentDate: type: string description: The date on which the patient was assessed as requiring the fit note. https://www.datadictionary.nhs.uk/nhs_business_definitions/emed3_fit_note_assessment_date.html format: date condition: type: string description: The reason that the care professional issued the fit note for the patient. https://www.datadictionary.nhs.uk/data_elements/emed3_fit_note_condition__snomed_ct_.html conditionIcd10Code: type: string description: The reason that the care professional issued the fit note for the patient. https://www.datadictionary.nhs.uk/data_elements/emed3_fit_note_diagnosis__icd_.html conditionSnomedCtCode: type: string description: The reason that the care professional issued the fit note for the patient. https://www.datadictionary.nhs.uk/data_elements/emed3_fit_note_condition__snomed_ct_.html emed3FitNoteId: type: string description: Primary key. emed3FitNoteIssuer: type: string description: The type of care professional responsible for issuing the fit note. https://www.datadictionary.nhs.uk/attributes/emed3_fit_note_issuer.html emed3FitNoteIssuerCode: type: string description: The type of care professional responsible for issuing the fit note. https://www.datadictionary.nhs.uk/attributes/emed3_fit_note_issuer.html emed3FitNoteIssuerLocalCode: type: string description: Emed3 Fit Note Issuer. endDate: type: string description: The date that the fit note applicable period ended. https://www.datadictionary.nhs.uk/data_elements/emed3_fit_note_end_date.html format: date isFollowUpAssessmentRequired: type: boolean description: An indication of whether a follow-up assessment is required at the end of the fit note applicable period. https://www.datadictionary.nhs.uk/attributes/emed3_fit_note_follow_up_assessment_required_indicator.html patientId: type: string description: Foreign key to the Patient. recordedDate: type: string description: The date on which a record of the fit note was recorded on the EHR. https://www.datadictionary.nhs.uk/nhs_business_definitions/emed3_fit_note_recorded_date.html 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 nullable: true items: type: string startDate: type: string description: The date that the fit note applicable period commenced. https://www.datadictionary.nhs.uk/data_elements/emed3_fit_note_start_date.html format: date uecAttendanceId: type: string description: Foreign key to the UEC Attendance that issued the fit note. description: Enables healthcare professionals to give advice to their patients about the impact of their health conditions on their fitness for work. It is used to provide medical evidence for employers or to support a claim to health-related benefits through the Department for Work and Pensions. Also known as "The Statement of Fitness for Work" or "sick note". https://www.datadictionary.nhs.uk/supporting_information/emed3_fit_note.html Osdk.EMed3FitNoteProperties: type: string enum: - endDate - patientId - startDate - rvGroupIds - emed3FitNoteIssuerLocalCode - applicablePeriodDurationDays - conditionIcd10Code - assessmentDate - condition - conditionSnomedCtCode - appointmentId - uecAttendanceId - admissionId - emed3FitNoteIssuer - recordedDate - emed3FitNoteId - isFollowUpAssessmentRequired - emed3FitNoteIssuerCode Osdk.EalEntry: required: - __apiName - __primaryKey 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 earliestClinicallyAppropriateDate: type: string description: The earliest date that it is clinically appropriate for the admission to take place. https://www.datadictionary.nhs.uk/data_elements/earliest_clinically_appropriate_date.html format: date earliestReasonableOfferDate: type: string description: "The date of the earliest of the reasonable offers made to\ \ the patient for an elective admission. A definition of what constitutes\ \ a reasonable offer can be found [here](https://www.datadictionary.nhs.uk/supporting_information/reasonable_offer.html).\ \ https://www.datadictionary.nhs.uk/data_elements/earliest_reasonable_offer_date.html" format: date episodeId: type: string description: Current RTT episode ID hasRttPathwayDescription: type: string description: "Status on RTT pathway (Active, Inactive, Non-RTT)" intendedManagement: type: string description: The intended pattern of hospital bed use for the patient. Decided when the decision is made to admit. https://www.datadictionary.nhs.uk/attributes/intended_management.html intendedManagementCode: type: string description: Data dictionary code. The intended pattern of hospital bed use for the patient. Decided when the decision is made to admit. https://www.datadictionary.nhs.uk/attributes/intended_management.html intendedManagementLocalCode: type: string description: The intended pattern of hospital bed use for the patient. Decided when the decision is made to admit. isRtt: type: boolean description: Defines if this is an active RTT pathway as per the rtt_pathway_status latestClinicallyAppropriateDate: type: string description: The latest date that it is clinically appropriate for the admission to take place. https://www.datadictionary.nhs.uk/data_elements/latest_clinically_appropriate_date.html format: date 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 nullable: true items: type: string title: type: string description: "Title of EAL entry (Specialty: Surname, Firstname)" Osdk.EalEntryProperties: type: string enum: - intendedManagementCode - pathwayId - patientName - dateOf18WeekRttBreach - rttPeriodIs68WeekWaiterString - rvGroupIds - rttDaysPaused - rttPeriod104WeekBreachDate - removalDate - ealId - daysTo18WeekRttBreach - earliestClinicallyAppropriateDate - lessThan10WeeksToRttBreachString - plannedDate - rttPeriod78WeekBreachDate - rttPeriodEndDate - latestClinicallyAppropriateDate - dateOf52WeekRttBreach - rttPeriodIs68WeekWaiter - intendedManagement - hasRttPathwayDescription - rttPeriodLength - decidedToAdmitDate - patientId - rttTimeBands - daysTo52WeekRttBreach - lessThan10WeeksToRttBreach - removalReason - episodeId - rttPeriodId - rttWeeksWaiting - rttPeriodDaysTo104WeekBreach - rttPeriodStartDate - removalReasonLocal - title - daysSinceDecidedToAdmitDate - isRtt - earliestReasonableOfferDate - priorityType - rttPeriodIs94WeekWaiter - rttStatusCode - intendedManagementLocalCode - rttPeriodDaysTo78WeekBreach - rttPeriodIs94WeekWaiterString Osdk.Encounter: required: - __apiName - __primaryKey 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 admissionOfferTimestamp: type: string description: The time that the procedure was booked in the system. (Not the TCI date) format: date-time admissionStatus: type: string description: Patient admission status admissionSubStatus: type: string description: Sub category of admission status admissionType: type: string description: "Admission type (e.g., Daycase, Ordinary Elective, Emergency,\ \ Other Non-Elective). Conforming to the following standards https://static.model.nhs.uk/downloads/2022TheatreProductivityDataSpecification_v2.1.xlsx" 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" cancerPriorityOrdering: type: integer description: 0-5 ordering on priority where 0 is the highest priority - used by Cancer 360 to determine which records to preferentially display in the cancer PTL. Typically a static mapping with clean_status. 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 division: type: string description: "A higher level division of specialty e.g. Medicine, Surgery,\ \ Women's and Oncology, etc." 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 genericWaitlistEntryId: type: string description: ID of the corresponding waitlist entry. Each encounter must have an equivalent generic waiting list entry. hasDateInTheLastNDays: type: boolean description: "Is surgical_order_date, admission_offer_timestamp or tci_date\ \ \"recent\", by default this means less than 3 days ago" 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 isAdmissionOfferTimestampInTheLastNDays: type: boolean description: "Is admission_offer_timestamp \"recent\", by default this means\ \ within the last 3 days" 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' isSurgicalOrderDateInTheLastNDays: type: boolean description: "Is surgical_order_date \"recent\", by default this means within\ \ the last 3 days" isTciDateInTheLastNDays: type: boolean description: "Is tci_date \"recent\", by default this means within the last\ \ 3 days" issues: type: array description: "List of patient readiness issues that have been raised on\ \ this encounter. If no issues the value should be [\"No Issues\"]" nullable: true 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. lastPoaExpiryDate: type: string description: The date that the most recent POA expires. If the trust uses Cerner then you will need to supply this property according to their custom derivation logic. format: date 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. lastPoaOutcomeDate: type: string description: Date of the 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. format: date lastPoaOutcomeFreeText: type: string description: Free text comments relating to the most recent POA outcome. 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 lastRefreshedAtSourceTimestamp: type: string description: Timestamp for when the data is calculated at source indicating when this data was last refreshed (not the same as ingest timestamp) 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. periOpRiskStratificationOutcomeDate: type: string description: Date of the outcome of peri-op risk stratification. format: date 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). 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. `" 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 nullable: true 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 sourceSystemNames: type: array description: String descriptors or display names of the source systems the data in this row is sourced from nullable: true items: type: string 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" surgicalOrderDate: type: string description: The date that the procedure was ordered format: date 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: "" Osdk.EncounterProperties: type: string enum: - calculatedTotalTheatreTime - criticalCareBedStatus - patientName - hasTci - lastPoaBookingStatus - rvGroupIds - primaryConsultantName - cancerPriorityOrdering - isBooked - removalDate - ealId - intendedPrimaryProcedureDescription - lastPoaScheduledOrAttendedDatetime - patientCancellationCount - removed - priorityLastUpdated - lastMrsaSwabBookingStatus - admissionMethod - needsReprioritisation - ward - createdDate - encounterFreeText - hasDateInTheLastNDays - hasFutureTci - primaryConsultantId - patientId - estimatedTotalTheatreTime - isSurgicalOrderDateInTheLastNDays - transferStatus - treatmentFunctionName - administrativeCategoryCode - lastMrsaSwabOutcome - suspectedCancerPathway - isAdmissionOfferTimestampInTheLastNDays - isTciDateInTheLastNDays - referralPriority - removalReason - createdBy - tciStatus - sourceSystemNames - intendedPrimaryProcedureFreeTextLong - specialtyName - lastCovidSwabOutcome - encounterId - intendedManagementDescription - intendedPrimaryProcedureAnaestheticType - latestRcsClinicalHarmReview - primaryProcedureStartTime - administrativeCategoryDescription - periOpRiskStratificationOutcome - intendedManagementCode - pathwayId - admissionOfferTimestamp - priority - treatmentFunctionCode - primaryProcedureType - encounterType - isSuitableForPooledList - waitlistCode - intendedPrimaryProcedureAnaesthetistRequired - specialtyId - isMetricEncounter - surgicalOrderDate - admissionSubStatus - atsTotalTheatreTime - lastPoaOutcomeDate - site - removalReasonCode - lastPoaOutcome - lastPoaExpiryDate - externalId - localTreatmentFunction - siteId - periOpRiskStratificationOutcomeDate - tciDate - genericWaitlistEntryId - poaRequired - issues - title - division - lastPoaOutcomeFreeText - lastCovidSwabBookingStatus - intendedPrimaryProcedureFreeText - lastRefreshedAtSourceTimestamp - intendedPrimaryProcedureCode - admissionType - priorityOrdered - admissionStatus Osdk.Endoscopy: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string attendedDate: type: string description: The date on which the endoscopy was attended. format: date cancerPriorityOrdering: type: integer description: 0-5 ordering on priority where 0 is the highest priority - used by Cancer 360 to determine which records to preferentially display in the cancer PTL. Typically a static mapping with clean_status. cleanStatus: type: string description: "The clean status of the histology data. Should be one of:\ \ ordered, scheduled, attended, cancelled, did not attend, reported" endoscopyExamId: type: string description: The unique identifier for the endoscopy. endoscopyExamType: type: string description: The type of endoscopy performed. endoscopyPriority: type: string description: The priority level of the endoscopy. examStatus: type: string description: The current status of the endoscopy. hasDateInTheLastNDays: type: boolean description: "Is attended_date, ordered_date, report_authorised_date or\ \ scheduled_date \"recent\", by default this means within the last 3 days" isAttendedDateInTheLastNDays: type: boolean description: "Is attended_date \"recent\", by default this means within\ \ the last 3 days" isOrderedDateInTheLastNDays: type: boolean description: "Is ordered_date \"recent\", by default this means within the\ \ last 3 days" isReportAuthorisedDateInTheLastNDays: type: boolean description: "Is report_authorised_date \"recent\", by default this means\ \ within the last 3 days" isReportPreparedDateInTheLastNDays: type: boolean description: "Is report_prepared_date \"recent\", by default this means\ \ within the last 3 days" isReported: type: boolean description: Indicates whether the endoscopy report has been completed. isScheduledDateInTheLastNDays: type: boolean description: "Is scheduled_date \"recent\", by default this means within\ \ the last 3 days" lastRefreshedAtSourceTimestamp: type: string description: The timestamp indicating when the data was last refreshed at the source. format: date-time modality: type: string description: "The type of imaging modality used for the radiology exam (e.g.,\ \ MRI, CT, X-ray, Ultrasound)." orderedDate: type: string description: The date on which the endoscopy was ordered. format: date patientId: type: string description: The foreign key for the person undergoing the endoscopy. reportAuthorisedDate: type: string description: Date when the report was authorised and ready for further use by cancer services.. format: date reportPreparedDate: type: string description: Date when report was sent for authorisation. format: date reportText: type: string description: The text content of the endoscopy report. 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 nullable: true items: type: string rvModules: type: array description: Deprecated property formerly used to set permissions nullable: true items: type: string scheduledDate: type: string description: The date on which the endoscopy was scheduled. format: date sourceSystemNames: type: array description: String descriptors or display names of the source systems the data in this row is sourced from nullable: true items: type: string description: "" Osdk.EndoscopyProperties: type: string enum: - isReported - reportText - rvGroupIds - attendedDate - cancerPriorityOrdering - examStatus - reportAuthorisedDate - endoscopyExamId - isReportAuthorisedDateInTheLastNDays - isAttendedDateInTheLastNDays - scheduledDate - orderedDate - hasDateInTheLastNDays - rvModules - cleanStatus - modality - patientId - endoscopyExamType - isReportPreparedDateInTheLastNDays - reportPreparedDate - sourceSystemNames - isScheduledDateInTheLastNDays - lastRefreshedAtSourceTimestamp - endoscopyPriority - isOrderedDateInTheLastNDays Osdk.ErsService: required: - __apiName - __primaryKey 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 nullable: true 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. nullable: true items: type: string uniqueId: type: string description: Unique Identifier for the eRS Service in Source System. description: "" Osdk.ErsServiceProperties: type: string enum: - referralReason - specialtyIds - uniqueId - serviceDirectoryId - serviceType - rvGroupIds - active - serviceName - siteId Osdk.Finding: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string findingCtv3code: type: string description: The CTV3 code to identify the finding. findingId: type: string description: Primary key. 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 nullable: true items: type: string virtualWardStayId: type: string description: "A foreign key to the [CDM] Virtual Ward Stay object type." description: "" Osdk.FindingProperties: type: string enum: - virtualWardStayId - findingId - rvGroupIds - findingCtv3code Osdk.GpPracticeRegistration: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string addressCity: type: string description: GP practice address city addressLine1: type: string description: GP practice address line 1 addressLine2: type: string description: GP practice address line 2 generalMedicalPractice: type: string description: Name of the GP practice generalMedicalPracticeId: type: string description: ODS code of the General Medical Practice associated with the patient generalMedicalPracticeOdsCode: type: string description: ODS code of the General Medical Practice associated with the patient icbOrganisationId: type: string description: ODS code for the Integrated Care Board organisation isLatestRegistration: type: boolean description: Indicator if this is the latest registration record for the patient namedGeneralPractitionerFirstName: type: string description: First name of the named General Practitioner for the patient namedGeneralPractitionerId: type: string description: "ODS code for the named General Practitioner, typically starting\ \ with G, e.g., G1234567" namedGeneralPractitionerLastName: type: string description: Last name of the named General Practitioner for the patient namedGeneralPractitionerPpdCode: type: string description: The NHS Prescription Services code used to identify the general medical practitioner patientId: type: string description: Foreign key for the patient postcode: type: string description: GP practice postcode registrationEndDate: type: string description: Date when the patient registration ended format: date registrationId: type: string description: Unique identifier for the registration registrationStartDate: type: string description: Date when the patient registration started 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 nullable: true items: type: string rvModules: type: array description: Deprecated property formerly used to set permissions nullable: true items: type: string subIcbLocationOrganisationId: type: string description: ODS code for the Sub-ICB Location organisation description: "" Osdk.GpPracticeRegistrationProperties: type: string enum: - rvModules - namedGeneralPractitionerFirstName - patientId - generalMedicalPracticeId - generalMedicalPractice - addressCity - namedGeneralPractitionerId - rvGroupIds - registrationStartDate - namedGeneralPractitionerPpdCode - subIcbLocationOrganisationId - icbOrganisationId - registrationEndDate - namedGeneralPractitionerLastName - registrationId - generalMedicalPracticeOdsCode - postcode - addressLine1 - isLatestRegistration - addressLine2 Osdk.Histology: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string cancerPriorityOrdering: type: integer description: 0-5 ordering on priority where 0 is the highest priority - used by Cancer 360 to determine which records to preferentially display in the cancer PTL. Typically a static mapping with clean_status. cleanStatus: type: string description: "The clean status of the histology data. Should be one of:\ \ ordered, scheduled, attended, cancelled, did not attend, reported" hasDateInTheLastNDays: type: boolean description: "Is is_received_at_lab_date_in_the_last_n_days, is_report_authorised_date_in_the_last_n_days,\ \ is_report_prepared_date_in_the_last_n_days, is_sample_prepared_date_in_the_last_n_days\ \ or is_sample_taken_date_in_the_last_n_days \"recent\", by default this\ \ means within the last 3 days" histologyId: type: string description: id of the histology and pk of the table. histologyPriority: type: string description: Indicator of what priority was requested for this histology. histologyStatus: type: string description: "The current raw string status from source system indicating\ \ the progress of the histology record. (e.g., Scheduled, Completed, Cancelled,\ \ In Progress, Reported)." histologyType: type: string description: The type of histology performed. isReceivedAtLabDateInTheLastNDays: type: boolean description: "Is received_at_lab_date \"recent\", by default this means\ \ within the last 3 days" isReportAuthorisedDateInTheLastNDays: type: boolean description: "Is report_authorised_date \"recent\", by default this means\ \ within the last 3 days" isReportPreparedDateInTheLastNDays: type: boolean description: "Is report_prepared_date \"recent\", by default this means\ \ within the last 3 days" isReported: type: boolean description: Indicator of whether the histology exam has been reported. isSamplePreparedDateInTheLastNDays: type: boolean description: "Is sample_prepared_date \"recent\", by default this means\ \ within the last 3 days" isSampleTakenDateInTheLastNDays: type: boolean description: "Is sample_taken_date \"recent\", by default this means within\ \ the last 3 days" lastRefreshedAtSourceTimestamp: type: string description: Date and time that this row of data was last refreshed at from the source system. format: date-time patientId: type: string description: Foreign key to the patient. receivedAtLabDate: type: string description: Date when sample was received at the lab. format: date reportAuthorisedDate: type: string description: Date when the report was authorised and ready for further use by cancer services. format: date reportPreparedDate: type: string description: Date when report was sent for authorisation. format: date reportText: type: string description: The text of the corresponding histology report once a report has been authorised. Null otherwise. 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 nullable: true items: type: string rvModules: type: array description: Deprecated property formerly used to set permissions nullable: true items: type: string samplePreparedDate: type: string description: Date when sample was prepared and ready to be examined. format: date sampleTakenDate: type: string description: Date when the sample was taken or is due to be taken. format: date sourceSystemNames: type: array description: String descriptors or display names of the source systems the data in this row is sourced from nullable: true items: type: string description: "" Osdk.HistologyProperties: type: string enum: - rvModules - cleanStatus - patientId - isReported - samplePreparedDate - reportText - rvGroupIds - isReportPreparedDateInTheLastNDays - reportPreparedDate - cancerPriorityOrdering - receivedAtLabDate - sourceSystemNames - reportAuthorisedDate - sampleTakenDate - isSamplePreparedDateInTheLastNDays - histologyPriority - histologyType - isReportAuthorisedDateInTheLastNDays - isSampleTakenDateInTheLastNDays - lastRefreshedAtSourceTimestamp - isReceivedAtLabDateInTheLastNDays - hasDateInTheLastNDays - histologyId - histologyStatus Osdk.HomeLeave: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string admissionId: type: string description: A foreign key to the Admission the patient is leaving from. consultantEpisodeId: type: string description: A foreign key to the Consultant Episode the patient is leaving from. endTimestamp: type: string description: The timestamp the period of home leave ended. https://www.datadictionary.nhs.uk/data_elements/end_date__home_leave_.html format: date-time homeLeaveId: type: string description: Primary key. patientId: type: string description: A foreign key to the 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 nullable: true items: type: string startTimestamp: type: string description: The start timestamp of the period of home leave. https://www.datadictionary.nhs.uk/data_elements/start_date__home_leave_.html format: date-time description: "When a patient who is using a hospital bed in ward or a bed in\ \ a care home spends a period of time outside the hospital/care home, usually\ \ at home, with the intention of returning to the same type of ward or care\ \ home to continue the episode of care. https://www.datadictionary.nhs.uk/nhs_business_definitions/home_leave.html" Osdk.HomeLeaveProperties: type: string enum: - patientId - startTimestamp - homeLeaveId - admissionId - rvGroupIds - endTimestamp - consultantEpisodeId Osdk.Injury: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string alcoholOrDrugInvolvementSnomedCtCodes: type: array description: "A list of alcohol or drugs used by the patient, which are\ \ thought likely to have contributed to the need to attend ED. https://www.datadictionary.nhs.uk/data_elements/emergency_care_injury_alcohol_or_drug_involvement__snomed_ct_.html" nullable: true items: type: string alcoholOrDrugInvolvements: type: array description: "A list of alcohol or drugs used by the patient, which are\ \ thought likely to have contributed to the need to attend ED. https://www.datadictionary.nhs.uk/data_elements/emergency_care_injury_alcohol_or_drug_involvement__snomed_ct_.html" nullable: true items: type: string assaultLocationDescription: type: string description: Provides further comments and/or details of the location where an assault took place. https://www.datadictionary.nhs.uk/data_elements/assault_location_description.html injuryActivityStatus: type: string description: "Whether the activity that lead to the injury was part of work,\ \ daily living, education etc. https://www.datadictionary.nhs.uk/data_elements/emergency_care_injury_activity_status__snomed_ct_.html" injuryActivityStatusSnomedCtCode: type: string description: "Whether the activity that lead to the injury was part of work,\ \ daily living, education etc. https://www.datadictionary.nhs.uk/data_elements/emergency_care_injury_activity_status__snomed_ct_.html" injuryActivityType: type: string description: The type of activity being undertaken by the patient at the moment the injury occurred. https://www.datadictionary.nhs.uk/data_elements/emergency_care_injury_activity_type__snomed_ct_.html injuryActivityTypeSnomedCtCode: type: string description: The type of activity being undertaken by the patient at the moment the injury occurred. https://www.datadictionary.nhs.uk/data_elements/emergency_care_injury_activity_type__snomed_ct_.html injuryId: type: string description: Primary key. injuryIntent: type: string description: The most likely human intent in the occurrence of the injury as assessed by the care professional. https://www.datadictionary.nhs.uk/data_elements/emergency_care_injury_intent__snomed_ct_.html injuryIntentSnomedCtCode: type: string description: The most likely human intent in the occurrence of the injury as assessed by the care professional. https://www.datadictionary.nhs.uk/data_elements/emergency_care_injury_intent__snomed_ct_.html injuryMechanism: type: string description: Describes how the injury was caused. https://www.datadictionary.nhs.uk/data_elements/emergency_care_injury_mechanism__snomed_ct_.html injuryMechanismSnomedCtCode: type: string description: Describes how the injury was caused. https://www.datadictionary.nhs.uk/data_elements/emergency_care_injury_mechanism__snomed_ct_.html injuryTimestamp: type: string description: The timestamp the patient was injured. https://www.datadictionary.nhs.uk/data_elements/injury_date_and_time.html format: date-time patientId: type: string description: A foreign key to the injured Patient. placeOfInjury: type: string description: The type of location at which the patient was present when the injury occurred. https://www.datadictionary.nhs.uk/data_elements/emergency_care_place_of_injury__snomed_ct_.html placeOfInjuryLatitudeDegrees: type: number description: "The latitude of the place of injury, expressed in decimal\ \ degrees. https://www.datadictionary.nhs.uk/data_elements/emergency_care_place_of_injury__latitude_.html" format: double placeOfInjuryLongitudeDegrees: type: number description: "The longitude of the place of injury, expressed in decimal\ \ degrees. https://www.datadictionary.nhs.uk/data_elements/emergency_care_place_of_injury__longitude_.html" format: double placeOfInjurySnomedCtCode: type: string description: The type of location at which the patient was present when the injury occurred. https://www.datadictionary.nhs.uk/data_elements/emergency_care_place_of_injury__snomed_ct_.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 nullable: true items: type: string uecAttendanceId: type: string description: A foreign key to the UEC Attendance the injured patient presented to. description: An injury a patient has when presenting at the emergency department. Osdk.InjuryProperties: type: string enum: - patientId - placeOfInjuryLatitudeDegrees - injuryMechanism - injuryId - placeOfInjury - rvGroupIds - injuryTimestamp - alcoholOrDrugInvolvements - injuryMechanismSnomedCtCode - uecAttendanceId - alcoholOrDrugInvolvementSnomedCtCodes - injuryActivityStatus - injuryActivityType - injuryActivityTypeSnomedCtCode - injuryActivityStatusSnomedCtCode - assaultLocationDescription - injuryIntentSnomedCtCode - placeOfInjuryLongitudeDegrees - placeOfInjurySnomedCtCode - injuryIntent Osdk.InterProviderTransfer: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string cancerPathwayId: type: string description: The identifier for the associated cancer pathway. cancerPathwayIptDate: type: string description: The date when the cancer pathway inter-provider transfer occurred. format: date interProviderTransferId: type: string description: The unique identifier for the inter-provider transfer. iptReason: type: string description: The reason for the inter-provider transfer. iptReceivedDate: type: string description: The date when the inter-provider transfer was received. format: date iptReturnedComment: type: string description: Comments related to the return of the inter-provider transfer. iptReturnedDate: type: string description: The date when the inter-provider transfer was returned. format: date iptSentComment: type: string description: Comments related to the sending of the inter-provider transfer. iptSentDate: type: string description: The date when the inter-provider transfer was sent. format: date iptSentOrReceived: type: boolean description: Indicates whether the inter-provider transfer has been sent or received. lastRefreshedAtSourceTimestamp: type: string description: The date and time that this row of data was last refreshed at from the source system. format: date-time mrn: type: string description: Medical record number/hospital number. nhsNumber: type: string description: "NHS number, National-level identifier for a patient." patientId: type: string description: The unique identifier for the patient. receivingOrgName: type: string description: The name of the receiving organization. receivingOrgOdsCode: type: string description: The ODS code of the receiving organization. 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 nullable: true items: type: string rvModules: type: array description: Deprecated property formerly used to set permissions nullable: true items: type: string sendingOrg: type: string description: The name of the sending organization. sendingOrgOdsCode: type: string description: The ODS code of the sending organization. sourceSystemNames: type: array description: String descriptors or display names of the source systems the data in this row is sourced from nullable: true items: type: string description: "" Osdk.InterProviderTransferProperties: type: string enum: - rvModules - patientId - iptReason - cancerPathwayId - iptSentComment - iptReceivedDate - sendingOrgOdsCode - nhsNumber - rvGroupIds - iptReturnedDate - mrn - iptSentOrReceived - sourceSystemNames - lastRefreshedAtSourceTimestamp - receivingOrgOdsCode - sendingOrg - cancerPathwayIptDate - iptSentDate - iptReturnedComment - interProviderTransferId - receivingOrgName Osdk.Labour: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string actualDeliveryPlace: type: string description: The actual place where the delivery takes place. https://www.datadictionary.nhs.uk/attributes/actual_delivery_place.html actualDeliveryPlaceCode: type: string description: The actual place where the delivery takes place. https://www.datadictionary.nhs.uk/attributes/actual_delivery_place.html actualDeliveryPlaceLocalCode: type: string description: The actual place where the delivery takes place. admissionId: type: string description: Foreign key to the admission the delivery belongs to. anaestheticGivenDuringLabourOrDelivery: type: string description: "If an anaesthetic was given during labour/delivery, this describes\ \ the type of anaesthetic. https://www.datadictionary.nhs.uk/data_elements/anaesthetic_given_during_labour_or_delivery_code.html" anaestheticGivenDuringLabourOrDeliveryCode: type: string description: "If an anaesthetic was given during labour/delivery, this describes\ \ the type of anaesthetic. https://www.datadictionary.nhs.uk/data_elements/anaesthetic_given_during_labour_or_delivery_code.html" anaestheticGivenDuringLabourOrDeliveryLocalCode: type: string description: "If an anaesthetic was given during labour/delivery, this describes\ \ the type of anaesthetic." anaestheticGivenPostLabourOrDelivery: type: string description: "If an anaesthetic was given after labour/delivery, this describes\ \ the type of anaesthetic. https://www.datadictionary.nhs.uk/data_elements/anaesthetic_given_post_labour_or_delivery_code.html" anaestheticGivenPostLabourOrDeliveryCode: type: string description: "If an anaesthetic was given after labour/delivery, this describes\ \ the type of anaesthetic. https://www.datadictionary.nhs.uk/data_elements/anaesthetic_given_post_labour_or_delivery_code.html" anaestheticGivenPostLabourOrDeliveryLocalCode: type: string description: "If an anaesthetic was given after labour/delivery, this describes\ \ the type of anaesthetic." consultantEpisodeId: type: string description: Foreign key to the consultant episode the delivery belongs to. deliveryPlaceChangeReason: type: string description: The reason the place of delivery is different from the place originally intended. https://www.datadictionary.nhs.uk/attributes/delivery_place_change_reason.html deliveryPlaceChangeReasonCode: type: string description: The reason the place of delivery is different from the place originally intended. https://www.datadictionary.nhs.uk/attributes/delivery_place_change_reason.html deliveryPlaceChangeReasonLocalCode: type: string description: The reason the place of delivery is different from the place originally intended. labourId: type: string description: Primary key. labourOrDeliveryOnsetMethod: type: string description: "The method by which the process of labour began, or delivery\ \ by caesarean section occurred. https://www.datadictionary.nhs.uk/attributes/labour_or_delivery_onset_method.html" labourOrDeliveryOnsetMethodCode: type: string description: "The method by which the process of labour began, or delivery\ \ by caesarean section occurred. https://www.datadictionary.nhs.uk/attributes/labour_or_delivery_onset_method.html" labourOrDeliveryOnsetMethodLocalCode: type: string description: "The method by which the process of labour began, or delivery\ \ by caesarean section occurred." pregnancyId: type: string description: A foreign key to Pregnancy. 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 nullable: true items: type: string description: A labour event that's associated with a single pregnancy. Each pregnancy will have at most one labour event; each labour event can have many births associated with it (e.g. in the case of twins/triplets etc). Osdk.LabourProperties: type: string enum: - actualDeliveryPlaceLocalCode - deliveryPlaceChangeReasonCode - pregnancyId - actualDeliveryPlace - rvGroupIds - deliveryPlaceChangeReason - consultantEpisodeId - anaestheticGivenPostLabourOrDeliveryCode - deliveryPlaceChangeReasonLocalCode - labourOrDeliveryOnsetMethodLocalCode - anaestheticGivenDuringLabourOrDeliveryCode - labourId - anaestheticGivenDuringLabourOrDelivery - labourOrDeliveryOnsetMethodCode - actualDeliveryPlaceCode - admissionId - anaestheticGivenPostLabourOrDelivery - labourOrDeliveryOnsetMethod - anaestheticGivenDuringLabourOrDeliveryLocalCode - anaestheticGivenPostLabourOrDeliveryLocalCode Osdk.ListAdmissionResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Admission" nextPageToken: type: string Osdk.ListAppointmentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Appointment" nextPageToken: type: string Osdk.ListAssignedCareProfessionalResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.AssignedCareProfessional" nextPageToken: type: string Osdk.ListBirthResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Birth" nextPageToken: type: string Osdk.ListBookingRequestCommentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.BookingRequestComment" nextPageToken: type: string Osdk.ListBookingRequestResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.BookingRequest" nextPageToken: type: string Osdk.ListCancerPathwayResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CancerPathway" nextPageToken: type: string Osdk.ListCancerTrackingCommentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CancerTrackingComment" nextPageToken: type: string Osdk.ListCancerTreatmentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CancerTreatment" nextPageToken: type: string Osdk.ListCareProfessionalResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CareProfessional" nextPageToken: type: string Osdk.ListCareServiceResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CareService" nextPageToken: type: string Osdk.ListCdmModulePermissioningResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CdmModulePermissioning" nextPageToken: type: string Osdk.ListCdmObjectPermissioningResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CdmObjectPermissioning" nextPageToken: type: string Osdk.ListCdmPathwayCommentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CdmPathwayComment" nextPageToken: type: string Osdk.ListCdmTeamMemberResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CdmTeamMember" nextPageToken: type: string Osdk.ListCdmTeamMembershipResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CdmTeamMembership" nextPageToken: type: string Osdk.ListCdmTeamResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CdmTeam" nextPageToken: type: string Osdk.ListChangeLogRequestResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ChangeLogRequest" nextPageToken: type: string Osdk.ListClinicLetterResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ClinicLetter" nextPageToken: type: string Osdk.ListClinicSessionResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ClinicSession" nextPageToken: type: string Osdk.ListClinicSlotResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ClinicSlot" nextPageToken: type: string Osdk.ListClinicTypeResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ClinicType" nextPageToken: type: string Osdk.ListComorbidityResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Comorbidity" nextPageToken: type: string Osdk.ListConsultantEpisodeResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ConsultantEpisode" nextPageToken: type: string Osdk.ListCriticalCareDailySummaryResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CriticalCareDailySummary" nextPageToken: type: string Osdk.ListCriticalCarePeriodResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CriticalCarePeriod" nextPageToken: type: string Osdk.ListDatasetRefreshTimeResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.DatasetRefreshTime" nextPageToken: type: string Osdk.ListDiagnosticsWaitlistEntryResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.DiagnosticsWaitlistEntry" nextPageToken: type: string Osdk.ListEMed3FitNoteResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.EMed3FitNote" nextPageToken: type: string Osdk.ListEalEntryResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.EalEntry" nextPageToken: type: string Osdk.ListEncounterResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Encounter" nextPageToken: type: string Osdk.ListEndoscopyResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Endoscopy" nextPageToken: type: string Osdk.ListErsServiceResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ErsService" nextPageToken: type: string Osdk.ListFindingResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Finding" nextPageToken: type: string Osdk.ListGpPracticeRegistrationResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.GpPracticeRegistration" nextPageToken: type: string Osdk.ListHistologyResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Histology" nextPageToken: type: string Osdk.ListHomeLeaveResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.HomeLeave" nextPageToken: type: string Osdk.ListInjuryResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Injury" nextPageToken: type: string Osdk.ListInterProviderTransferResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.InterProviderTransfer" nextPageToken: type: string Osdk.ListLabourResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Labour" nextPageToken: type: string Osdk.ListLogEditCdmModulePermissioningResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.LogEditCdmModulePermissioning" nextPageToken: type: string Osdk.ListLogUpdateOptionalGroupIdsForObjectPermissioningResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.LogUpdateOptionalGroupIdsForObjectPermissioning" nextPageToken: type: string Osdk.ListMdtMeetingResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.MdtMeeting" nextPageToken: type: string Osdk.ListMdtNoteResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.MdtNote" nextPageToken: type: string Osdk.ListMentalHealthActLegalStatusResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.MentalHealthActLegalStatus" nextPageToken: type: string Osdk.ListObservationResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Observation" nextPageToken: type: string Osdk.ListOutpatientActivityResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.OutpatientActivity" nextPageToken: type: string Osdk.ListOverseasVisitorChargingCategoryPeriodResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.OverseasVisitorChargingCategoryPeriod" nextPageToken: type: string Osdk.ListPatientAddressHistoryResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.PatientAddressHistory" nextPageToken: type: string Osdk.ListPatientDiagnosisResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.PatientDiagnosis" nextPageToken: type: string Osdk.ListPatientPathwayResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.PatientPathway" nextPageToken: type: string Osdk.ListPatientResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Patient" nextPageToken: type: string Osdk.ListPregnancyResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Pregnancy" nextPageToken: type: string Osdk.ListProcedureResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Procedure" nextPageToken: type: string Osdk.ListProcedureStatusResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ProcedureStatus" nextPageToken: type: string Osdk.ListProcedureTypeResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ProcedureType" nextPageToken: type: string Osdk.ListRadiologyExamResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.RadiologyExam" nextPageToken: type: string Osdk.ListReferralResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Referral" nextPageToken: type: string Osdk.ListScoredAssessmentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ScoredAssessment" nextPageToken: type: string Osdk.ListSiteResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Site" nextPageToken: type: string Osdk.ListSpecialtyResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Specialty" nextPageToken: type: string Osdk.ListStaffUnavailabilityResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.StaffUnavailability" nextPageToken: type: string Osdk.ListTestResultResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.TestResult" nextPageToken: type: string Osdk.ListTheatreBookingResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.TheatreBooking" nextPageToken: type: string Osdk.ListTheatreSessionCommentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.TheatreSessionComment" nextPageToken: type: string Osdk.ListTheatreSessionResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.TheatreSession" nextPageToken: type: string Osdk.ListTransferOfCareRequestResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.TransferOfCareRequest" nextPageToken: type: string Osdk.ListTrustSettingResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.TrustSetting" nextPageToken: type: string Osdk.ListUecAttendanceResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.UecAttendance" nextPageToken: type: string Osdk.ListUecReferralResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.UecReferral" nextPageToken: type: string Osdk.ListUrlResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Url" nextPageToken: type: string Osdk.ListUserPreferenceResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.UserPreference" nextPageToken: type: string Osdk.ListValidatedChangeLogCommentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ValidatedChangeLogComment" nextPageToken: type: string Osdk.ListValidatedChangelogResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ValidatedChangelog" nextPageToken: type: string Osdk.ListVirtualWardResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.VirtualWard" nextPageToken: type: string Osdk.ListVirtualWardStayResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.VirtualWardStay" nextPageToken: type: string Osdk.ListWaitlistEntryResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.WaitlistEntry" nextPageToken: type: string Osdk.ListWaitlistResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Waitlist" nextPageToken: type: string Osdk.ListWardResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Ward" nextPageToken: type: string Osdk.ListWardStayResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.WardStay" nextPageToken: type: string Osdk.LogEditCdmModulePermissioning: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string actionRid: type: string actionSummary: type: string actionTimestamp: type: string format: date-time actionTriggererUserId: type: string actionTypeRid: type: string actionTypeVersion: type: string cdmModulePermissioning: type: array nullable: true items: type: string cdmModulePermissioningModuleGroupIds_5: type: array nullable: true items: type: string cdmModulePermissioningModuleName_5: type: string isReverted: type: boolean moduleGroupIds_3: type: array nullable: true items: type: string newParameter_5: type: string revertTimestamp: type: string format: date-time revertUser: type: string description: "This object type was automatically created when logging was enabled\ \ for the Action type: Edit Module Permissioning" Osdk.LogEditCdmModulePermissioningProperties: type: string enum: - isReverted - moduleGroupIds_3 - actionRid - actionTypeVersion - actionTypeRid - actionTriggererUserId - cdmModulePermissioningModuleGroupIds_5 - newParameter_5 - revertTimestamp - cdmModulePermissioningModuleName_5 - actionSummary - revertUser - cdmModulePermissioning - actionTimestamp Osdk.LogUpdateOptionalGroupIdsForObjectPermissioning: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string actionRid: type: string actionSummary: type: string actionTimestamp: type: string format: date-time actionTriggererUserId: type: string actionTypeRid: type: string actionTypeVersion: type: string cdmObjectPermissioning: type: array nullable: true items: type: string cdmObjectPermissioningModules_6: type: array nullable: true items: type: string cdmObjectPermissioningObjectGroupIds_6: type: array nullable: true items: type: string cdmObjectPermissioningObjectId_6: type: string cdmObjectPermissioningObjectName_6: type: string isReverted: type: boolean newParameter_6: type: string objectGroupIds_5: type: array nullable: true items: type: string revertTimestamp: type: string format: date-time revertUser: type: string description: "This object type was automatically created when logging was enabled\ \ for the Action type: Update Optional Group IDs for Object Permissioning" Osdk.LogUpdateOptionalGroupIdsForObjectPermissioningProperties: type: string enum: - isReverted - cdmObjectPermissioningObjectId_6 - cdmObjectPermissioningObjectGroupIds_6 - actionRid - actionTypeRid - actionTypeVersion - cdmObjectPermissioningObjectName_6 - actionTriggererUserId - objectGroupIds_5 - revertTimestamp - newParameter_6 - cdmObjectPermissioning - actionSummary - cdmObjectPermissioningModules_6 - revertUser - actionTimestamp Osdk.MdtMeeting: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string lastRefreshedAtSourceTimestamp: type: string description: The date and time that this row of data was last refreshed at from the source system. format: date-time mdtMeetingId: type: string description: The primary key for the MDT meeting. mdtStatus: type: string description: The status of the MDT meeting. meetingTimestamp: type: string description: The timestamp indicating when the MDT meeting took place. format: date-time 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 nullable: true items: type: string rvModules: type: array description: Deprecated property formerly used to set permissions nullable: true items: type: string sourceSystemNames: type: array description: String descriptors or display names of the source systems the data in this row is sourced from nullable: true items: type: string description: "" Osdk.MdtMeetingProperties: type: string enum: - rvModules - lastRefreshedAtSourceTimestamp - mdtStatus - meetingTimestamp - rvGroupIds - mdtMeetingId - sourceSystemNames Osdk.MdtNote: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string cancerPathwayId: type: string description: The foreign key for the cancer pathway this note is about. lastRefreshedAtSourceTimestamp: type: string description: The date and time that this row of data was last refreshed at from the source system. format: date-time lastUpdatedTimestamp: type: string description: The time at which the note was last created or updated. format: date-time mdtMeetingId: type: string description: The foreign key of the MDT meeting this note was made in preparation for or as a result of. mdtNoteId: type: string description: The unique identifier for the MDT note. mdtNoteText: type: string description: The text content of the MDT note. noteType: type: string description: String descriptor of what kind of note this allows front end users to differentiate between notes made in advance of a MDT meeting for a specific area and an outcome note. 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 nullable: true items: type: string rvModules: type: array description: Deprecated property formerly used to set permissions nullable: true items: type: string sourceSystemNames: type: array description: String descriptors or display names of the source systems the data in this row is sourced from nullable: true items: type: string description: "" Osdk.MdtNoteProperties: type: string enum: - noteType - rvModules - lastRefreshedAtSourceTimestamp - cancerPathwayId - lastUpdatedTimestamp - mdtNoteId - rvGroupIds - mdtMeetingId - mdtNoteText - sourceSystemNames Osdk.MentalHealthActLegalStatus: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string expiryTimestamp: type: string description: When the mental health act classification status expires. https://www.datadictionary.nhs.uk/data_elements/mental_health_act_legal_status_classification_expiry_timestamp.html format: date-time mentalHealthActLegalStatusClassification: type: string description: "The act the patient is detained under, or, an indication that\ \ the patient is informally detained. https://www.datadictionary.nhs.uk/attributes/mental_health_act_legal_status_classification_code.html" mentalHealthActLegalStatusClassificationCode: type: string description: "The act the patient is detained under, or, an indication that\ \ the patient is informally detained. https://www.datadictionary.nhs.uk/attributes/mental_health_act_legal_status_classification_code.html" mentalHealthActLegalStatusClassificationCodeLocalCode: type: string description: "The act the patient is detained under, or, an indication that\ \ the patient is informally detained." mentalHealthActLegalStatusId: type: string description: Primary key. patientId: type: string description: Foreign key to the detained 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 nullable: true items: type: string startTimestamp: type: string description: When the mental health act classification status began. https://www.datadictionary.nhs.uk/data_elements/mental_health_act_legal_status_classification_assignment_period_start_timestamp.html format: date-time description: Indicates which mental health act a patient is detained under. Also indicates when a patient is informally detained. https://www.datadictionary.nhs.uk/classes/mental_health_act_legal_status_classification.html Osdk.MentalHealthActLegalStatusProperties: type: string enum: - mentalHealthActLegalStatusClassificationCode - mentalHealthActLegalStatusClassificationCodeLocalCode - patientId - mentalHealthActLegalStatusClassification - startTimestamp - rvGroupIds - expiryTimestamp - mentalHealthActLegalStatusId Osdk.Observation: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string observationCtv3code: type: string description: A CTV-3 code for an observation from a specific clinical terminology. observationId: type: string description: Primary key. patientId: type: string description: "A foreign key to the [CDM] Patient object 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 nullable: true items: type: string virtualWardStayId: type: string description: "A foreign key to the [CDM] Virtual Ward Stay object type." description: "" Osdk.ObservationProperties: type: string enum: - virtualWardStayId - patientId - observationId - rvGroupIds - observationCtv3code Osdk.OutpatientActivity: required: - __apiName - __primaryKey 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 genericWaitlistEntryId: type: string 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 nullable: true 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 nullable: true 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: "" Osdk.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 - genericWaitlistEntryId - issues - earliestDueDate - rttPeriodStartDate - lastCancelledAppointmentId - title - division - removedTimestamp - daysWaiting - referralId Osdk.OverseasVisitorChargingCategoryPeriod: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string applicableEndDate: type: string description: The date the overseas visitor charging category was applicable until. https://www.datadictionary.nhs.uk/data_elements/overseas_visitor_charging_category_applicable_end_date.html format: date applicableFromDate: type: string description: The when the overseas visitor charging category was applicable from. https://www.datadictionary.nhs.uk/data_elements/overseas_visitor_charging_category_applicable_from_date.html format: date overseasVisitorChargingCategory: type: string description: The charging category relating to the overseas visitor status. https://www.datadictionary.nhs.uk/attributes/overseas_visitor_charging_category.html overseasVisitorChargingCategoryCode: type: string description: The charging category relating to the overseas visitor status. https://www.datadictionary.nhs.uk/attributes/overseas_visitor_charging_category.html overseasVisitorChargingCategoryLocalCode: type: string description: Charging category code for local use. overseasVisitorChargingCategoryPeriodId: type: string description: Primary key. patientId: type: string description: Foreign key to the 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 nullable: true items: type: string description: A history table for the patient's overseas visitor charging category. An overseas visitor charging category categorises overseas visitors who are not exempt from charges by virtue of the NHS. https://www.datadictionary.nhs.uk/nhs_business_definitions/overseas_visitor_charging_category.html Osdk.OverseasVisitorChargingCategoryPeriodProperties: type: string enum: - overseasVisitorChargingCategoryPeriodId - patientId - applicableFromDate - overseasVisitorChargingCategory - rvGroupIds - overseasVisitorChargingCategoryCode - overseasVisitorChargingCategoryLocalCode - applicableEndDate Osdk.Patient: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string accessibleInformationProfessionalRequired: type: string description: The type of communication professional the patient needs support from. https://www.datadictionary.nhs.uk/data_elements/accessible_information_communication_support_code__snomed_ct_.html accessibleInformationProfessionalRequiredSnomedCtCode: type: string description: The type of communication professional the patient needs support from. https://www.datadictionary.nhs.uk/data_elements/accessible_information_communication_support_code__snomed_ct_.html accommodationStatus: type: string description: The type of accommodation that the patient currently has. https://www.datadictionary.nhs.uk/attributes/accommodation_status_code.html accommodationStatusCode: type: string description: Data dictionary code. The type of accommodation that the patient currently has. https://www.datadictionary.nhs.uk/attributes/accommodation_status_code.html accommodationStatusLocalCode: type: string description: Accommodation status. activeAdditionalNeeds: type: array description: "Additional needs relevant to this patient. E.g. Dementia,\ \ ADHD, 2 DNAs, No Fixed Abode, ... This should only be used for Cancer\ \ 360 and will eventually be derived based on a future patient alerts\ \ object." nullable: true items: type: string addressCity: type: string description: Patient address city 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' email: type: string description: |- Email address of the patient or the patient's lead contact who is the designated contact. https://www.datadictionary.nhs.uk/data_elements/contact_email_address__patient_or_lead_contact_.html?hl=email ethnicCategory: type: string description: "The ethnicity of the patient, based on the classification\ \ used for the 2001 census. https://www.datadictionary.nhs.uk/attributes/ethnic_category_code_2001.html" ethnicCategoryCode: type: string description: "Data dictionary code. The ethnicity of the patient, based\ \ on the classification used for the 2001 census. https://www.datadictionary.nhs.uk/attributes/ethnic_category_code_2001.html" ethnicCategoryLocalCode: type: string description: Ethnic category. 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." genderIdentityCode: 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. This field is typically used in\ \ mental health contexts rather than acute contexts, so most EPRs don't\ \ have this field; they use stated_gender instead. https://www.datadictionary.nhs.uk/attributes/gender_identity_code.html" interpreterLanguage: type: string description: The language of the interpreter required for the patient. https://www.datadictionary.nhs.uk/data_elements/interpreter_language__snomed_ct_.html interpreterLanguageSnomedCtCode: type: string description: The language of the interpreter required for the patient. https://www.datadictionary.nhs.uk/data_elements/interpreter_language__snomed_ct_.html isCarerSupportAvailable: type: boolean description: An indication of whether carer support is available to the patient at their normal residence. https://www.datadictionary.nhs.uk/data_elements/carer_support_indicator.html localAuthority: type: string description: |- Local authority that the patient currently resides in. https://www.datadictionary.nhs.uk/nhs_business_definitions/local_authority.html?hl=local%2Cauthority 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 nextOfKinNumberSecondary: type: string description: Secondary next of kin contact number (e.g. home). nextOfKinRelationshipType: type: string description: Next of kin relation to patient nhsNumber: type: string description: "NHS number, National-level identifier for a patient https://www.datadictionary.nhs.uk/attributes/nhs_number.html" nhsNumberStatusIndicator: type: string description: The trace status of the NHS number. https://www.datadictionary.nhs.uk/attributes/nhs_number_status_indicator_code.html nhsNumberStatusIndicatorCode: type: string description: Data dictionary code. The trace status of the NHS number. https://www.datadictionary.nhs.uk/attributes/nhs_number_status_indicator_code.html nhsNumberStatusIndicatorLocalCode: type: string description: NHS number status indicator. patientExternalId: type: string description: The external id of the patient. personId: type: string description: "ID, a unique identifier for each patient" personMaritalStatus: type: string description: Identifies the marital status of the patient. https://www.datadictionary.nhs.uk/attributes/person_marital_status.html personMaritalStatusCode: type: string description: Data dictionary code. Identifies the marital status of the patient. https://www.datadictionary.nhs.uk/attributes/person_marital_status.html personMaritalStatusLocalCode: type: string description: Person marital status. phenotypicSex: type: string description: "A classification of the observed sex of a patient, relating\ \ to the biological, physiological and physical characteristics that differentiate\ \ men and women, determined by endocrine influences. https://www.datadictionary.nhs.uk/attributes/person_phenotypic_sex_classification.html" phenotypicSexCode: type: string description: "A classification of the observed sex of a patient, relating\ \ to the biological, physiological and physical characteristics that differentiate\ \ men and women, determined by endocrine influences. https://www.datadictionary.nhs.uk/attributes/person_phenotypic_sex_classification.html" phoneNumber: type: string description: Patient primary phone number phoneNumberSecondary: type: string description: Patient secondary phone number postcode: type: string description: Patient postcode preferredSpokenLanguage: type: string description: The preferred spoken language of the patient. https://www.datadictionary.nhs.uk/data_elements/preferred_spoken_language__snomed_ct_.html preferredSpokenLanguageSnomedCtCode: type: string description: The preferred spoken language of the patient. https://www.datadictionary.nhs.uk/data_elements/preferred_spoken_language__snomed_ct_.html 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 nullable: true items: type: string school: type: string description: |- School that the patient is enrolled in (if any). https://www.datadictionary.nhs.uk/nhs_business_definitions/school.html?hl=school sex: type: string description: DEPRECATED - use phenotypic_sex instead. Patient Sex (Male/Female/Indeterminate) statedGender: type: string description: The gender of the patient self declared or inferred by observation for those unable to declare their gender. https://www.datadictionary.nhs.uk/attributes/person_stated_gender_code.html statedGenderCode: type: string description: The gender of the patient self declared or inferred by observation for those unable to declare their gender. https://www.datadictionary.nhs.uk/attributes/person_stated_gender_code.html surname: type: string description: Surname temporaryAddressCity: type: string description: Patient temporary address city temporaryAddressLine1: type: string description: Patient temporary address line 1 temporaryAddressLine2: type: string description: Patient temporary address line 2 temporaryPostcode: type: string description: Patient temporary address postcode title: type: string description: "Mode of address for this patient (e.g. (Mr, Mrs, Ms, Dr)" Osdk.PatientAddressHistory: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string address: type: string description: The address of the patient's permanent residence. https://www.datadictionary.nhs.uk/data_elements/patient_usual_address.html city: type: string description: The city of the patient's permanent address. country: type: string description: The country of the patient's permanent address. county: type: string description: The county of the patient's permanent address. endDate: type: string description: The date the patient moved out of the address. format: date patientAddressHistoryId: type: string description: Primary key. patientId: type: string description: Foreign key to the Patient. postcode: type: string description: The postcode of the patient's permanent residence. https://www.datadictionary.nhs.uk/data_elements/postcode_of_usual_address.html residenceResponsibility: type: string description: The commissioner responsible for the patient's local area. https://www.datadictionary.nhs.uk/data_elements/organisation_identifier__residence_responsibility_.html residenceResponsibilityOdsCode: type: string description: The commissioner responsible for the patient's local area. https://www.datadictionary.nhs.uk/data_elements/organisation_identifier__residence_responsibility_.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 nullable: true items: type: string startDate: type: string description: The date the patient moved into the address. format: date description: A history table for the patient's address. Osdk.PatientAddressHistoryProperties: type: string enum: - endDate - city - country - residenceResponsibility - patientId - address - residenceResponsibilityOdsCode - startDate - rvGroupIds - county - postcode - patientAddressHistoryId Osdk.PatientDiagnosis: required: - __apiName - __primaryKey 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. admissionId: type: string description: Foreign key to the admission the patient was diagnosed in. consultantEpisodeId: type: string description: Foreign key to the consultant episode the patient was diagnosed in. diagnosisEndDate: type: string description: Date when diagnosis was resolved/in remission. This can be `null` if the diagnosis is active. format: date diagnosisIcd10Code: type: string description: The patient's diagnosis. diagnosisId: type: string description: ID for each diagnosis diagnosisName: type: string description: "Name of diagnosis (e.g. Thyrotoxicosis, Neurofibroma)" diagnosisSnomedCtCode: type: string description: The patient's diagnosis. diagnosisStartDate: type: string description: Date when diagnosis became active or was coded format: date diagnosisTimestamp: type: string description: The timestamp the patient was diagnosed. format: date-time encounterId: type: string description: encounter ID at which the diagnosis was created as part of isPrimaryDiagnosis: type: boolean description: Whether the diagnosis is the main condition being treated or investigated. patientId: type: string description: patient ID for the subject of the diagnosis patientPathwayId: type: string description: Foreign key to the pathway the patient was diagnosed on. 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 nullable: true items: type: string uecAttendanceId: type: string description: Foreign key to the UEC Attendance the patient was diagnosed in. virtualWardStayId: type: string description: "A foreign key to the [CDM] Virtual Ward Stay object type." description: Patient diagnosis with active/inactive status Osdk.PatientDiagnosisProperties: type: string enum: - diagnosisTimestamp - patientId - isPrimaryDiagnosis - rvGroupIds - diagnosisStartDate - diagnosisEndDate - consultantEpisodeId - diagnosisId - uecAttendanceId - virtualWardStayId - patientPathwayId - encounterId - diagnosisSnomedCtCode - admissionId - active - diagnosisName - diagnosisIcd10Code Osdk.PatientPathway: required: - __apiName - __primaryKey type: object properties: _104WeeksBreachDate: type: string description: Date of 104 week breach format: date _18WeeksBreachDate: type: string description: Date of 18 week breach format: date _52WeeksBreachDate: type: string description: Date of 52 week breach format: date _65WeeksBreachDate: type: string description: Date of 65 week breach format: date _78WeeksBreachDate: type: string description: Date of 78 week breach format: date __apiName: type: string __primaryKey: type: string __rid: type: string accessibilityFlags: type: array description: Extra considerations that teams may need to take into account when booking in appointments or making other operational decisions nullable: true items: 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 closureReason: type: string description: "Reason why the patient on this pathway was discharged (e.g.,\ \ treatment given) or pathway was closed (e.g., duplicate pathway)" 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 daysTo104WeekBreachDate: type: integer description: Days to 104 week breach date daysTo18WeekBreachDate: type: integer description: Days to 18 week breach date daysTo52WeekBreachDate: type: integer description: Days to 52 week breach date daysTo65WeekBreachDate: type: integer description: Days to 65 week breach date daysTo78WeekBreachDate: type: integer description: Days to 78 week breach date derivedPathwayType: type: string description: Always derived pathway type categorising pathways into standardised operationally meaningful groups. Used by UPL to categorise user actions by pathway type. 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. isActiveRttPathway: type: boolean description: Boolean which is 'true' if there is currently an active period on the pathway (period with no clock stop) isOpenPathway: type: boolean description: Boolean which is 'true' if the pathway is currently open and 'false' if the pathway has been Closed/Discharged etc. This is derived from the pathway_end_date if provided 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 latestEpisodeId: type: string description: The episode in the RTT pathway that corresponds to the latest RTT period. latestPathwayStatusCodeNational: type: string description: The latest status code of the pathway. This refers to what is known in the data dictionary as the rtt period status - https://www.datadictionary.nhs.uk/attributes/referral_to_treatment_period_status.html latestPathwayStatusDescriptionNational: type: string description: The description of the latest status code of the pathway. This refers to what is known in the data dictionary as the rtt period status - https://www.datadictionary.nhs.uk/attributes/referral_to_treatment_period_status.html latestPeriodEndDate: type: string description: The end date of the latest period on the pathway format: date latestPeriodEndReason: type: string description: The end reason of the latest period on the pathway latestPeriodLengthDays: type: integer description: The length of the latest period on the pathway latestPeriodLengthWeeks: type: integer description: The length of the latest period on the pathway latestPeriodStartDate: type: string description: The start date of the latest period on the pathway format: date latestPeriodStartReason: type: string description: The start reason of the latest period on the pathway latestProcedurePriorityCode: type: string description: "Should contain values P2, P3 or P4 as per national waiting\ \ list prioritization guidance introduced during the Coronavirus Pandemic" 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 latestRttPeriodId: type: string description: The id of the latest period on the pathway 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 originalReferralSpecialtyId: type: string description: "The id of the specialty 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." originalReferralSpecialtyName: type: string description: "The name of the specialty 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." owlClinicCode: type: string description: Clinic code entered on outpatient waiting list. Can be derived from 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. Derived as the last requested appointment type from outpatient-activity. pathwayClass: type: string description: Indicates whether the pathway is Admitted vs Non-Admitted pathwayEndDate: type: string description: The date when the pathway was closed or the patient was discharged. format: date pathwayId: type: string description: "Primary Key: https://www.datadictionary.nhs.uk/attributes/patient_pathway_identifier.html" pathwayStage: type: string description: Stage of the pathway the patient is at based on Trust's local categorization pathwayStartDate: type: string description: "The start date of the pathway. If not provided on pathway,\ \ this will be the earliest of the original referral received date and\ \ first pathway start date." format: date pathwayStatus: type: string description: "Whether the pathway is an Active RTT Pathway, an Inactive\ \ RTT Pathway or a Non-RTT Pathway" pathwaySubtype: type: string description: "Pathway categorization based on mandated time-to-treatment\ \ requirements, e.g. 2 weeks wait, 18 weeks wait." pathwayType: type: string description: "Different categories indicating the type of pathway the patient\ \ is on (e.g. Active RTT, Inactive RTT, Cancer, Diagnostic, Non-RTT)" 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 ppid: type: string description: "Stands for Patient Pathway Identifier. It's an identifier,\ \ which together with the organisation identifier of the issuer, uniquely\ \ identifies the pathway. At the beginning of the patient's journey, the\ \ first organisation receiving the referral should generate the PPID;\ \ the PPID should then remain consistent, even if care is transferred\ \ across to another organisation. https://www.datadictionary.nhs.uk/attributes/patient_pathway_identifier.html" ppidIssuer: type: string description: The first organisation to receive the patient's referral and generate the PPID. https://www.datadictionary.nhs.uk/data_elements/organisation_code__patient_pathway_identifier_issuer_.html ppidIssuerOdsCode: type: string description: The first organisation to receive the patient's referral and generate the PPID. https://www.datadictionary.nhs.uk/data_elements/organisation_code__patient_pathway_identifier_issuer_.html prospectiveRttPeriodEndDate: type: string description: "The earliest date of the next appointment, next outpatient\ \ appointment, or next TCI (planned admission) for this pathway." format: date prospectiveRttWeeksWait: type: integer description: The number of weeks between the start of the latest RTT period and the next planned event (like an appointment or admission). 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 referralId: type: string description: Foreign key to the referral initiated the pathway. 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 nullable: true 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." waitingTimeMeasurementType: type: string description: The type of waiting time measurement methodology applied to the patient pathway. https://www.datadictionary.nhs.uk/attributes/waiting_time_measurement_type.html waitingTimeMeasurementTypeCode: type: string description: The type of waiting time measurement methodology applied to the patient pathway. https://www.datadictionary.nhs.uk/attributes/waiting_time_measurement_type.html waitingTimeMeasurementTypeCodeLocalCode: type: string description: The type of waiting time measurement methodology applied to the patient pathway. weeksTo104WeekBreachDate: type: integer description: Weeks to the 104 week breach date weeksTo18WeekBreachDate: type: integer description: Weeks to the 18 week breach date weeksTo52WeekBreachDate: type: integer description: Weeks to the 52 week breach date weeksTo65WeekBreachDate: type: integer description: Weeks to the 65 week breach date weeksTo78WeekBreachDate: type: integer description: Weeks to the 78 week breach date weeksWaitSinceDtaDate: type: integer description: The number of weeks since the decision to admit was made. weeksWaitSinceLastPatientContact: type: integer description: The number of weeks since the patient last had an appointment or outpatient visit. weeksWaitToProspectiveRttPeriodEndDate: type: integer description: The number of weeks until the next planned activity (like an appointment or admission). weeksWaitToTciDate: type: integer description: The number of weeks until the patient’s next planned admission (TCI date). description: "" Osdk.PatientPathwayProperties: type: string enum: - lastTestResultDate - latestPathwayStatusCodeNational - weeksWaitSinceDtaDate - mrn - covidPriorityDate - daysTo104WeekBreachDate - _52WeeksBreachDate - isOpenPathway - ubrn - pathwayType - daysTo18WeekBreachDate - derivedPathwayType - intendedProcedureDescription - patientId - ppidIssuer - weeksWaitToProspectiveRttPeriodEndDate - _104WeeksBreachDate - lastOpaDate - consultantId - latestPeriodStartReason - siteName - latestPeriodStartDate - nextAppointmentDescription - pathwayClass - specialtyName - ppidIssuerOdsCode - latestPeriodLengthDays - nextDiagnosticsDate - pathwayEndDate - owlClinicCode - directorate - treatmentFunctionCode - latestPeriodEndDate - waitingTimeMeasurementType - lastAppointmentDescription - nhsNumber - weeksTo78WeekBreachDate - owlFlag - specialtyId - lastPathwayActivity - latestPathwayStatusDescriptionNational - daysTo52WeekBreachDate - nhsCcg - latestEpisodeId - _65WeeksBreachDate - siteId - patientDeceased - weeksTo104WeekBreachDate - admissionMethodCode - nextOpaDate - tciDate - nextAppointment - lastPathwayActivityDate - pathwayStartDate - pathwaySubtype - _18WeeksBreachDate - isActiveRttPathway - accessibilityFlags - referralReceivedDate - lastClinicLetterType - referralId - patientName - waitingTimeMeasurementTypeCodeLocalCode - rvGroupIds - nextAppointmentStatus - referralDate - _78WeeksBreachDate - weeksWaitSinceLastPatientContact - latestRttPeriodId - latestPeriodLengthWeeks - dtaDate - age - pathwayStatus - treatmentFunctionName - referralPriority - latestPeriodEndReason - waitingTimeMeasurementTypeCode - referralSource - originalReferralSpecialtyName - prospectiveRttWeeksWait - lastOpaOutcome - lastAppointment - pathwayStage - originalReferralSpecialtyId - weeksWaitToTciDate - pathwayId - prospectiveRttPeriodEndDate - localSubSpecialtyCode - weeksTo65WeekBreachDate - lastClinicLetterDate - dateOfBirth - daysTo78WeekBreachDate - dataSource - consultantName - covidPriority - closureReason - owlGroupCode - daysTo65WeekBreachDate - weeksTo52WeekBreachDate - localSubSpecialtyDescription - latestProcedurePriorityCode - lastAppointmentDate - latestReferralReceivedDate - division - ppid - weeksTo18WeekBreachDate - nextAppointmentDate Osdk.PatientProperties: type: string enum: - email - temporaryAddressCity - personMaritalStatusLocalCode - rvGroupIds - fullName - mrn - nhsNumberStatusIndicatorLocalCode - sex - surname - interpreterLanguage - genderIdentity - personId - postcode - phoneNumber - nextOfKinName - localAuthority - ethnicCategoryLocalCode - age - phenotypicSex - temporaryAddressLine2 - accommodationStatus - nhsNumberStatusIndicatorCode - accommodationStatusLocalCode - phenotypicSexCode - accessibleInformationProfessionalRequiredSnomedCtCode - temporaryPostcode - nhsNumberStatusIndicator - addressCity - nhsNumber - temporaryAddressLine1 - nextOfKinNumber - dateOfBirth - statedGender - genderIdentityCode - isCarerSupportAvailable - ethnicCategory - personMaritalStatus - statedGenderCode - deceased - preferredSpokenLanguageSnomedCtCode - accessibleInformationProfessionalRequired - title - firstName - registeredGp - activeAdditionalNeeds - preferredSpokenLanguage - patientExternalId - accommodationStatusCode - interpreterLanguageSnomedCtCode - phoneNumberSecondary - dateOfDeath - nextOfKinNumberSecondary - addressLine1 - nextOfKinRelationshipType - school - personMaritalStatusCode - addressLine2 - ethnicCategoryCode Osdk.Pregnancy: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string antenatalResponsibleGpCareProfessionalId: type: string description: Foreign key to the general medical practitioner responsible for the patient's antenatal care. https://www.datadictionary.nhs.uk/data_elements/general_medical_practitioner__antenatal_care_.html firstAntenatalAssessmentDate: type: string description: The date on which the patient was assessed and arrangements were made for antenatal care. https://www.datadictionary.nhs.uk/nhs_business_definitions/first_antenatal_assessment_date.html format: date intendedDeliveryPlace: type: string description: The delivery place type where the patient plans to have her baby. https://www.datadictionary.nhs.uk/attributes/intended_delivery_place.html intendedDeliveryPlaceCode: type: string description: The delivery place type where the patient plans to have her baby. https://www.datadictionary.nhs.uk/attributes/intended_delivery_place.html intendedDeliveryPlaceCodeLocalCode: type: string description: The delivery place type where the patient plans to have her baby. numberOfPreviousPregnanciesResultingInRegistrableBirths: type: integer description: The number of previous pregnancies resulting in one or more registrable births. https://www.datadictionary.nhs.uk/data_elements/number_of_previous_pregnancies_resulting_in_registrable_birth.html patientId: type: string description: A foreign key to the pregnant patient object type. pregnancyId: type: string description: Primary key. 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 nullable: true items: type: string description: Carries details that span across a pregnancy. Osdk.PregnancyProperties: type: string enum: - intendedDeliveryPlaceCode - patientId - pregnancyId - intendedDeliveryPlaceCodeLocalCode - rvGroupIds - firstAntenatalAssessmentDate - numberOfPreviousPregnanciesResultingInRegistrableBirths - antenatalResponsibleGpCareProfessionalId - intendedDeliveryPlace Osdk.Procedure: required: - __apiName - __primaryKey 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) admissionId: type: string description: Foreign key to the admission the procedure was performed in. 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' appointmentId: type: string description: Foreign key to the appointment the procedure occurred in. consultantEpisodeId: type: string description: Foreign key to the consultant episode the procedure occurred in. 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" procedure: type: string description: The procedure. 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 procedureOpcsCode: type: string description: 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) procedureSnomedCtCode: type: string description: The procedure. 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 procedureTimestamp: type: string description: The timestamp the procedure occurred at. https://www.datadictionary.nhs.uk/data_elements/coded_procedure_timestamp.html format: date-time responsibleAnaesthetistCareProfessionalId: type: string description: Foreign key to the anaesthetist responsible for the patient throughout the procedure. 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 nullable: true 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}`" uecAttendanceId: type: string description: Foreign key to the UEC attendance the procedure was performed in. virtualWardStayId: type: string description: "A foreign key to the [CDM] Virtual Ward Stay object type." description: "" Osdk.ProcedureProperties: type: string enum: - priority - procedure - responsibleAnaesthetistCareProfessionalId - admissionMethodDescription - procedureTimeOrOrder - rvGroupIds - actualProcedureTimeKnifeToSkinClosure - consultantEpisodeId - procedureOrdered - estimatedProcedureTimeKnifeToSkinClosure - actualProcedureTimeTotalTheatreTime - uecAttendanceId - appointmentId - virtualWardStayId - procedureId - admissionId - procedureTimestamp - expectedLengthOfStay - isPrimaryProcedure - estimatedProcedureTimeStrategy - estimatedProcedureTimeTotalTheatreTime - primaryConsultantId - procedureDate - intendedProcedureCode - intendedProcedureDescription - patientId - anaesthetistRequired - title - procedureOpcsCode - intendedProcedureFreeText - procedureSnomedCtCode - encounterId - priorityOrdered - theatreSessionId - anaestheticTypeToBeUsed Osdk.ProcedureStatus: required: - __apiName - __primaryKey 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 poaExpiryDate: type: string description: Date that the POA expires format: date 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 poaOutcomeDate: type: string description: Date of the outcome of the POA appointment format: date 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 nullable: true items: type: string theatreBookingId: type: string description: ID for the theatre booking event at which the procedure takes place description: "" Osdk.ProcedureStatusProperties: type: string enum: - theatreBookingId - covidSwabBookedDatetime - rvGroupIds - poaOutcomeDate - poaOutcomeFreeText - poaAppointmentId - covidSwabOutcome - procedureId - poaOrdering - mrsaSwabBookingStatus - isPrimaryProcedure - poaBookedDatetime - patientId - covidSwabBookingStatus - mrsaSwabBookedDatetime - covidSwabAppointmentId - poaExpiryDate - poaScheduledOrAttendedDatetime - procedureStatusId - mrsaSwabOutcome - poaOutcome - covidSwabAttendedDatetime - encounterId - mrsaSwabAppointmentId - mrsaSwabAttendedDatetime - poaBookingStatus Osdk.ProcedureType: required: - __apiName - __primaryKey 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 nullable: true items: type: string description: "" Osdk.ProcedureTypeProperties: type: string enum: - procedureDescription - procedureCode - rvGroupIds Osdk.RadiologyExam: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string attendedDate: type: string description: The date on which the radiology exam was attended. format: date cancerPriorityOrdering: type: integer description: 0-5 ordering on priority where 0 is the highest priority - used by Cancer 360 to determine which records to preferentially display in the cancer PTL. Typically a static mapping with clean_status. cleanExamStatus: type: string description: The clean status of the radiology exam data. examStatus: type: string description: The current status of the radiology exam. hasDateInTheLastNDays: type: boolean description: "Is attended_date, ordered_date, report_authorised_date, report_prepared_date\ \ or scheduled_date \"recent\", by default this means within the last\ \ 3 days" isAttendedDateInTheLastNDays: type: boolean description: "Is attended_date \"recent\", by default this means within\ \ the last 3 days" isOrderedDateInTheLastNDays: type: boolean description: "Is ordered_date \"recent\", by default this means within the\ \ last 3 days" isReportAuthorisedDateInTheLastNDays: type: boolean description: "Is report_authorised_date \"recent\", by default this means\ \ within the last 3 days" isReportPreparedDateInTheLastNDays: type: boolean description: "Is report_prepared_date \"recent\", by default this means\ \ within the last 3 days" isReported: type: boolean description: Indicates whether the radiology report has been completed. isScheduledDateInTheLastNDays: type: boolean description: "Is scheduled_date \"recent\", by default this means within\ \ the last 3 days" lastRefreshedAtSourceTimestamp: type: string description: The date and time that this row of data was last refreshed at from the source system. format: date-time modality: type: string description: The modality used in the radiology exam. orderedDate: type: string description: The date on which the radiology exam was ordered. format: date patientId: type: string description: The foreign key for the person undergoing the radiology exam. radiologyExamId: type: string description: The unique identifier for the radiology exam. radiologyExamType: type: string description: The type of radiology exam performed. radiologyPriority: type: string description: The priority level the radiology exam was booked at. reportAuthorisedDate: type: string description: Date when the report was authorised and ready for further use by cancer services. format: date reportPreparedDate: type: string description: Date when report was sent for authorisation. format: date reportText: type: string description: The text content of the radiology report. 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 nullable: true items: type: string rvModules: type: array description: Deprecated property formerly used to set permissions nullable: true items: type: string scheduledDate: type: string description: The date on which the radiology exam was scheduled. format: date sourceSystemNames: type: array description: String descriptors or display names of the source systems the data in this row is sourced from nullable: true items: type: string description: "" Osdk.RadiologyExamProperties: type: string enum: - isReported - reportText - rvGroupIds - attendedDate - cancerPriorityOrdering - examStatus - reportAuthorisedDate - isReportAuthorisedDateInTheLastNDays - isAttendedDateInTheLastNDays - scheduledDate - orderedDate - radiologyPriority - radiologyExamType - hasDateInTheLastNDays - radiologyExamId - cleanExamStatus - rvModules - modality - patientId - isReportPreparedDateInTheLastNDays - reportPreparedDate - sourceSystemNames - isScheduledDateInTheLastNDays - lastRefreshedAtSourceTimestamp - isOrderedDateInTheLastNDays Osdk.Referral: required: - __apiName - __primaryKey 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 isReferralToVirtualWard: type: boolean description: A flag indicating whether the referral is to a virtual ward. 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." nullable: true items: type: string patientId: type: string description: the patient receiving a service patientIsOnCancerPathway: type: boolean description: '`True` if patient is on cancer pathway' presentingComplaint: type: string description: Used to identify the presenting complaint as assessed by the care professional. https://www.datadictionary.nhs.uk/data_elements/presenting_complaint__coded_clinical_entry_.html presentingComplaintIcd10Code: type: string description: The ICD-10 used to identify the presenting complaint as assessed by the care professional. presentingComplaintSnomedCtCode: type: string description: The SNOMED code used to identify the presenting complaint as assessed by the care professional. primaryCareProfessionalId: type: string description: Primary care professional assigned to the referral primaryReferralReason: type: string description: The primary reason for the referral. primaryReferralReasonCode: type: string description: The code for the primary reason for the referral. primaryReferralReasonToVirtualWardCode: type: string description: "The code for the primary reason for the referral to virtual\ \ ward, please refer to virtual ward mds specification. https://digital.nhs.uk/about-nhs-digital/corporate-information-and-documents/directions-and-data-provision-notices/data-provision-notices-dpns/virtual-wards-minimum-data-set" priority: type: string description: "The priority of the referral request (e.g. Urgent, Routine)\ \ https://www.datadictionary.nhs.uk/attributes/priority_type.html" priorityCode: type: string description: The priority of the referral request. https://www.datadictionary.nhs.uk/attributes/priority_type.html priorityLocalCode: type: string description: The priority of the referral request. referralId: type: string description: ID for the referral referralLetterContent: type: string description: The full text content of the referral letter referralLetterRid: $ref: "#/components/schemas/Core.MediaReference" referralNotes: type: string description: Accompanying notes sent alongside the referral referralReceivedTimestamp: type: string description: The timestamp the referral was received. format: date-time referralRejectionReason: type: string description: The reason the referral was rejected. referralRejectionReasonCode: type: string description: The code for the reason the referral was rejected. referralRejectionTimestamp: type: string description: The timestamp the referral was rejected. format: date-time 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 referralSourceCode: 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 referralSourceLocalCode: type: string description: The source of referral of each Consultant Out-Patient Episode. referralType: type: string description: The type of referral. referrerId: type: string description: A unique ID for the care professional who made the referral. Note that this is not a foreign key. https://www.datadictionary.nhs.uk/data_elements/referrer_code.html referringOrganisation: type: string description: "The organisation from which the referral was made, such as\ \ a GP practice, NHS trust or NHS Foundation Trust. https://www.datadictionary.nhs.uk/data_elements/referring_organisation_code.html" referringOrganisationOdsCode: type: string description: "The organisation from which the referral was made, such as\ \ a GP practice, NHS trust or NHS Foundation Trust. https://www.datadictionary.nhs.uk/data_elements/referring_organisation_code.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" requestedConsultationMechanism: type: string description: "Communication mechanism of the requested appointment (e.g.\ \ Telephone, Clinic, Face to face, etc) https://www.datadictionary.nhs.uk/attributes/consultation_mechanism.html" 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 nullable: true 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 serviceTypeRequested: type: string description: "Whether the referral was for a specific procedure, advice/consultation,\ \ or something else. https://www.datadictionary.nhs.uk/attributes/service_type_requested.html" serviceTypeRequestedCode: type: string description: "Whether the referral was for a specific procedure, advice/consultation,\ \ or something else. https://www.datadictionary.nhs.uk/attributes/service_type_requested.html" serviceTypeRequestedLocalCode: type: string description: "Whether the referral was for a specific procedure, advice/consultation,\ \ or something else." 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)" treatmentFunction: type: string description: The specialty the patient has been referred for. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html treatmentFunctionCode: type: string description: The specialty the patient has been referred for. https://www.datadictionary.nhs.uk/attributes/treatment_function_code.html treatmentFunctionLocalCode: type: string description: The specialty the patient has been referred for. trustOdsCode: type: string description: The ODS code of the NHS trust that received the referral. ubrn: type: string description: The unique booking reference number of the referral. https://www.datadictionary.nhs.uk/attributes/unique_booking_reference_number__converted_.html wasPatientReferredToDirectAccessService: type: boolean description: A boolean that's true when the patient has been referred to a direct access service. https://www.datadictionary.nhs.uk/attributes/direct_access_referral_indicator.html wasReferredByFirstContactPractitioner: type: boolean description: "A boolean that's true when the patient was referred by a first\ \ contact practitioner (e.g. physiotherapist, podiatrist, etc) https://www.datadictionary.nhs.uk/attributes/direct_access_referral_indicator.html" weeksWaiting: type: integer description: Weeks waiting since the referral was received description: "" Osdk.ReferralProperties: type: string enum: - presentingComplaint - dateReferralAccepted - primaryReferralReason - rvGroupIds - serviceName - fullName - mrn - patientIsOnCancerPathway - serviceTypeRequestedCode - presentingComplaintSnomedCtCode - rttPeriodEndDate - removed - referralType - treatmentFunction - ubrn - requestedConsultationMechanism - referralNotes - priorityCode - daysToBookWithin - sourceUniqueId - dateReferralReceived - rttPeriodLength - patientId - primaryCareProfessionalId - serviceType - wasReferredByFirstContactPractitioner - referralLetterContent - siteName - serviceTypeRequestedLocalCode - referralSource - trustOdsCode - dueDate - specialtyName - referralReceivedTimestamp - serviceId - weeksWaiting - referralRejectionTimestamp - pathwayId - treatmentFunctionCode - priority - presentingComplaintIcd10Code - status - primaryReferralReasonCode - priorityLocalCode - referralSourceLocalCode - requestedAppointmentType - rttPathwayStatus - specialtyId - dateReferralCreated - source - referralSourceCode - referralRejectionReasonCode - siteId - primaryReferralReasonToVirtualWardCode - referralLetterRid - earliestDueDate - serviceTypeRequested - rttPeriodStartDate - referringOrganisation - title - wasPatientReferredToDirectAccessService - treatmentFunctionLocalCode - referringOrganisationOdsCode - referralRejectionReason - isReferralToVirtualWard - removedTimestamp - daysWaiting - referrerId - referralId Osdk.ScoredAssessment: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string admissionId: type: string description: Foreign key to the admission the assessment was completed in. appointmentId: type: string description: Foreign key to the appointment the assessment was completed in. assessmentToolType: type: string description: The type of scored assessment being used. https://www.datadictionary.nhs.uk/data_elements/coded_assessment_tool_type__snomed_ct_.html assessmentToolTypeSnomedCtCode: type: string description: The type of scored assessment being used. https://www.datadictionary.nhs.uk/data_elements/coded_assessment_tool_type__snomed_ct_.html completionTimestamp: type: string description: The timestamp the assessment was completed. https://www.datadictionary.nhs.uk/nhs_business_definitions/assessment_tool_completion_timestamp.html format: date-time consultantEpisodeId: type: string description: Foreign key to the consultant episode the assessment was completed in. patientId: type: string description: Foreign key to the patient being assessed. personScore: type: string description: The score resulting from the assessment. https://www.datadictionary.nhs.uk/attributes/person_score.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 nullable: true items: type: string scoredAssessmentId: type: string description: Primary key. uecAttendanceId: type: string description: Foreign key to the UEC attendance the assessment was completed in. virtualWardStayId: type: string description: "A foreign key to the [CDM] Virtual Ward Stay object type." description: An assessment used to evaluate the patient that results in a score. https://www.datadictionary.nhs.uk/classes/assessment_tool.html Osdk.ScoredAssessmentProperties: type: string enum: - uecAttendanceId - virtualWardStayId - appointmentId - patientId - completionTimestamp - personScore - admissionId - rvGroupIds - consultantEpisodeId - assessmentToolTypeSnomedCtCode - scoredAssessmentId - assessmentToolType Osdk.SearchAdmissionResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Admission" nextPageToken: type: string Osdk.SearchAppointmentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Appointment" nextPageToken: type: string Osdk.SearchAssignedCareProfessionalResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.AssignedCareProfessional" nextPageToken: type: string Osdk.SearchBirthResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Birth" nextPageToken: type: string Osdk.SearchBookingRequestCommentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.BookingRequestComment" nextPageToken: type: string Osdk.SearchBookingRequestResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.BookingRequest" nextPageToken: type: string Osdk.SearchCancerPathwayResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CancerPathway" nextPageToken: type: string Osdk.SearchCancerTrackingCommentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CancerTrackingComment" nextPageToken: type: string Osdk.SearchCancerTreatmentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CancerTreatment" nextPageToken: type: string Osdk.SearchCareProfessionalResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CareProfessional" nextPageToken: type: string Osdk.SearchCareServiceResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CareService" nextPageToken: type: string Osdk.SearchCdmModulePermissioningResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CdmModulePermissioning" nextPageToken: type: string Osdk.SearchCdmObjectPermissioningResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CdmObjectPermissioning" nextPageToken: type: string Osdk.SearchCdmPathwayCommentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CdmPathwayComment" nextPageToken: type: string Osdk.SearchCdmTeamMemberResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CdmTeamMember" nextPageToken: type: string Osdk.SearchCdmTeamMembershipResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CdmTeamMembership" nextPageToken: type: string Osdk.SearchCdmTeamResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CdmTeam" nextPageToken: type: string Osdk.SearchChangeLogRequestResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ChangeLogRequest" nextPageToken: type: string Osdk.SearchClinicLetterResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ClinicLetter" nextPageToken: type: string Osdk.SearchClinicSessionResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ClinicSession" nextPageToken: type: string Osdk.SearchClinicSlotResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ClinicSlot" nextPageToken: type: string Osdk.SearchClinicTypeResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ClinicType" nextPageToken: type: string Osdk.SearchComorbidityResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Comorbidity" nextPageToken: type: string Osdk.SearchConsultantEpisodeResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ConsultantEpisode" nextPageToken: type: string Osdk.SearchCriticalCareDailySummaryResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CriticalCareDailySummary" nextPageToken: type: string Osdk.SearchCriticalCarePeriodResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.CriticalCarePeriod" nextPageToken: type: string Osdk.SearchDatasetRefreshTimeResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.DatasetRefreshTime" nextPageToken: type: string Osdk.SearchDiagnosticsWaitlistEntryResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.DiagnosticsWaitlistEntry" nextPageToken: type: string Osdk.SearchEMed3FitNoteResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.EMed3FitNote" nextPageToken: type: string Osdk.SearchEalEntryResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.EalEntry" nextPageToken: type: string Osdk.SearchEncounterResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Encounter" nextPageToken: type: string Osdk.SearchEndoscopyResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Endoscopy" nextPageToken: type: string Osdk.SearchErsServiceResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ErsService" nextPageToken: type: string Osdk.SearchFindingResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Finding" nextPageToken: type: string Osdk.SearchGpPracticeRegistrationResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.GpPracticeRegistration" nextPageToken: type: string Osdk.SearchHistologyResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Histology" nextPageToken: type: string Osdk.SearchHomeLeaveResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.HomeLeave" nextPageToken: type: string Osdk.SearchInjuryResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Injury" nextPageToken: type: string Osdk.SearchInterProviderTransferResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.InterProviderTransfer" nextPageToken: type: string Osdk.SearchLabourResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Labour" nextPageToken: type: string Osdk.SearchLogEditCdmModulePermissioningResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.LogEditCdmModulePermissioning" nextPageToken: type: string Osdk.SearchLogUpdateOptionalGroupIdsForObjectPermissioningResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.LogUpdateOptionalGroupIdsForObjectPermissioning" nextPageToken: type: string Osdk.SearchMdtMeetingResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.MdtMeeting" nextPageToken: type: string Osdk.SearchMdtNoteResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.MdtNote" nextPageToken: type: string Osdk.SearchMentalHealthActLegalStatusResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.MentalHealthActLegalStatus" nextPageToken: type: string Osdk.SearchObservationResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Observation" nextPageToken: type: string Osdk.SearchOutpatientActivityResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.OutpatientActivity" nextPageToken: type: string Osdk.SearchOverseasVisitorChargingCategoryPeriodResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.OverseasVisitorChargingCategoryPeriod" nextPageToken: type: string Osdk.SearchPatientAddressHistoryResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.PatientAddressHistory" nextPageToken: type: string Osdk.SearchPatientDiagnosisResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.PatientDiagnosis" nextPageToken: type: string Osdk.SearchPatientPathwayResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.PatientPathway" nextPageToken: type: string Osdk.SearchPatientResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Patient" nextPageToken: type: string Osdk.SearchPregnancyResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Pregnancy" nextPageToken: type: string Osdk.SearchProcedureResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Procedure" nextPageToken: type: string Osdk.SearchProcedureStatusResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ProcedureStatus" nextPageToken: type: string Osdk.SearchProcedureTypeResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ProcedureType" nextPageToken: type: string Osdk.SearchRadiologyExamResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.RadiologyExam" nextPageToken: type: string Osdk.SearchReferralResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Referral" nextPageToken: type: string Osdk.SearchScoredAssessmentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ScoredAssessment" nextPageToken: type: string Osdk.SearchSiteResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Site" nextPageToken: type: string Osdk.SearchSpecialtyResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Specialty" nextPageToken: type: string Osdk.SearchStaffUnavailabilityResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.StaffUnavailability" nextPageToken: type: string Osdk.SearchTestResultResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.TestResult" nextPageToken: type: string Osdk.SearchTheatreBookingResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.TheatreBooking" nextPageToken: type: string Osdk.SearchTheatreSessionCommentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.TheatreSessionComment" nextPageToken: type: string Osdk.SearchTheatreSessionResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.TheatreSession" nextPageToken: type: string Osdk.SearchTransferOfCareRequestResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.TransferOfCareRequest" nextPageToken: type: string Osdk.SearchTrustSettingResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.TrustSetting" nextPageToken: type: string Osdk.SearchUecAttendanceResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.UecAttendance" nextPageToken: type: string Osdk.SearchUecReferralResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.UecReferral" nextPageToken: type: string Osdk.SearchUrlResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Url" nextPageToken: type: string Osdk.SearchUserPreferenceResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.UserPreference" nextPageToken: type: string Osdk.SearchValidatedChangeLogCommentResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ValidatedChangeLogComment" nextPageToken: type: string Osdk.SearchValidatedChangelogResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.ValidatedChangelog" nextPageToken: type: string Osdk.SearchVirtualWardResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.VirtualWard" nextPageToken: type: string Osdk.SearchVirtualWardStayResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.VirtualWardStay" nextPageToken: type: string Osdk.SearchWaitlistEntryResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.WaitlistEntry" nextPageToken: type: string Osdk.SearchWaitlistResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Waitlist" nextPageToken: type: string Osdk.SearchWardResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.Ward" nextPageToken: type: string Osdk.SearchWardStayResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Osdk.WardStay" nextPageToken: type: string Osdk.Site: required: - __apiName - __primaryKey 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 nullable: true items: type: string siteOdsCode: type: string description: The organisation code for the site. https://www.datadictionary.nhs.uk/attributes/organisation_site_code.html description: "" Osdk.SiteProperties: type: string enum: - id - siteOdsCode - name - rvGroupIds Osdk.Specialty: required: - __apiName - __primaryKey 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 nullable: true 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: "" Osdk.SpecialtyProperties: type: string enum: - specialtyName - rvGroupIds - isActiveSpecialty - theatreSpecialty - specialtyId Osdk.StaffUnavailability: required: - __apiName - __primaryKey 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 nullable: true 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." Osdk.StaffUnavailabilityProperties: type: string enum: - id - notes - hours - leaveEndTime - careProfessionalId - rvGroupIds - dateOfLeave - title - leaveStartTime - leaveState Osdk.TestResult: required: - __apiName - __primaryKey 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 lastRefreshedAtSourceTimestamp: type: string description: Timestamp to be set when the data is calculated at source to indicate when this data was last refreshed (not the same as ingest timestamp) 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 arederived from `object_id` and the `restricted-view-policy` dataset nullable: true items: type: string sourceSystemNames: type: array description: String descriptors or display names of the source systems the data in this row is sourced from nullable: true 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\"." testOrderedTimestamp: type: string description: The timestamp when the test was ordered. format: date-time testResultId: type: string description: ID for the test result testValueType: type: string description: Indicates the data type of the test result value uecAttendanceId: type: string description: The UEC attendance the test/investigation was carried out in. 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: all test results for each appointments Osdk.TestResultProperties: type: string enum: - testOrderedTimestamp - patientId - orderingSpecialtyName - attendanceId - testDate - testName - rvGroupIds - testId - sourceSystemNames - uecAttendanceId - unit - expiryDate - lastRefreshedAtSourceTimestamp - testValueType - value - valueDouble - testResultId Osdk.TheatreBooking: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string adjustedExpectedDuration: type: string description: "The expected duration for the booking, based on a default\ \ or custom calculation." 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" lastPoaExpiryDate: type: string description: Date that the most recent POA expires format: date lastPoaOutcomeDate: type: string description: Date of the outcome of the most recent POA appointment format: date lastPoaOutcomeFreeText: type: string description: Free text comments relating to POA outcome 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 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 periOpRiskStratificationOutcomeDate: type: string description: Date of the outcome of peri-op risk stratification. format: date 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 nullable: true 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 tciTimestamp: type: string description: Time to come in format: date-time 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: "" Osdk.TheatreBookingProperties: type: string enum: - intendedManagementCode - statusRender - criticalCareBedStatus - priority - adjustedExpectedDuration - theatreBookingId - status - rvGroupIds - primaryConsultantName - cancellationReason - datetimeBooked - mrn - fullName - tciTimestamp - intendedPrimaryProcedureAnaesthetistRequired - ealId - intendedPrimaryProcedureDescription - cancelledOtd - lastPoaOutcomeDate - riskRating - lastPoaExpiryDate - expectedDuration - periOpRiskStratificationOutcomeDate - primaryConsultantId - primaryProcedureStartTimeOrOrder - patientId - postOpBedRequired - cancellationDate - lastPoaOutcomeFreeText - bookingCancelled - intendedPrimaryProcedureFreeText - primaryProcedureId - encounterId - cancellationReasonFreeText - riskDescription - rttPathwayId - theatreSessionDate - periOpRiskStratificationOutcome - theatreSessionId Osdk.TheatreSession: required: - __apiName - __primaryKey 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) anaestheticTypes: type: array description: Contains the concatenation of which type of anaesthetics used in the session nullable: true items: type: string anaesthetistIds: type: array description: Array of all IDs for anaesthetists assigned to the session nullable: true 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" nullable: true 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 cancellationReason: type: string description: Textual reason for the cancellation of a theatre session. Conforming to the following standards https://static.model.nhs.uk/downloads/2022TheatreProductivityDataSpecification_v2.1.xlsx cancelled: type: boolean description: '`True` if the status field has the value "Cancelled"' comments: type: array description: Comments on theatre session for scheduling purposes nullable: true items: type: string consultantIds: type: array description: Array of all IDs for consultants assigned to the session nullable: true 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" nullable: true 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 plannedSessionMinutes: type: integer description: "Minutes within the session allocated to booked patients, prior\ \ to the day of the session" plannedSessionUtilisation: type: number description: "Planned utilisation ratio, defined as (planned session minutes\ \ / total minutes available)" format: double 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 nullable: true 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)" Osdk.TheatreSessionComment: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string commentHistory: type: array description: "Comment History of the form 'username - timestamp - comment\ \ - tags', includes ' - Deleted' in the record where a comment was deleted." nullable: true items: type: string commentId: type: string description: ID of the comment commentText: type: string description: String text of comment commentTimestamp: type: string description: Timestamp at creation of comment format: date-time commentUpdatedTimestamp: type: string description: Comment last updated timestamp format: date-time commentUser: type: string description: Multipass user id of user creating comment reason: type: string description: Reason why comment was left status: type: string description: Status of the comment tags: type: array description: Tags on the comment nullable: true items: type: string theatreSessionId: type: string description: ID of the theatre session updatedBy: type: string description: Comment last updator multipass user id description: "" Osdk.TheatreSessionCommentProperties: type: string enum: - reason - updatedBy - commentText - tags - commentHistory - status - commentTimestamp - commentId - commentUser - commentUpdatedTimestamp - theatreSessionId Osdk.TheatreSessionProperties: type: string enum: - comments - anaesthetistIds - rvGroupIds - primaryConsultantName - cancellationReason - bookingCancellationsOnTheDayCount - anaesthetistNames - pooledList - weekDeltaStringDetails - actualUtilisationStatus - anaestheticTypes - plannedStartTime - consultantLeaveStatus - actualUtilisedMinutes - cancelled - plannedDurationMinutes - usableUnbookedMinutes - primaryConsultantId - excludeFromTheatreScheduling - stretchedStartTime - hasAnnualLeave - excludeFromPoa - bookedMinutes - actualUtilisation - adjustedBookedUtilisationStatus - dayOfWeekOrdered - adjustedDurationMinutes - shortDisplayName - specialtyName - bookedUtilisation - doubleBookedConsultant - consultantIds - mnemonic - dayOfWeek - theatreName - doubleBookedTheatre - dayOfWeekIndex - theatreId - status - theatreType - weekDelta - countCriticalCareBedsRequired - durationMinutes - specialtyId - mnemonicShort - sortKey - site - bookingCancellationsTotalCount - siteId - endTime - bookedUtilisationStatus - amPm - plannedEndTime - unbookedMinutesStatus - date - countBedsRequired - anaesthetistRequired - type - plannedSessionMinutes - countOfBookings - primaryAnaesthetistId - unbookedMinutes - startTime - plannedSessionUtilisation - weekDeltaString - adjustedBookedUtilisation - primaryAnaesthetistName - stretchedEndTime - consultantNames - hasAnnualLeaveString - theatreSessionId Osdk.TransferOfCareRequest: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string destinationCareServiceId: type: string description: Foreign key to the care service to which this transfer was requested. requestAcceptedDate: type: string description: The date on which this transfer request was accepted by the destination service. format: date requestCreatedDate: type: string description: The date on which this transfer request was created. format: date requestReceivedDate: type: string description: The date on which this transfer request was received by the destination service. format: date requestedByCareServiceId: type: string description: Foreign key to the care service from which this transfer was requested. resultingAdmissionId: type: string description: Foreign key to the resulting admission which occurs upon completion of this transfer of care. sourceAdmissionId: type: string description: Foreign key to the admission from which the transfer request was initiated. status: type: string description: "The current status of the transfer request (Open, Accepted,\ \ Completed, Dismissed)." transferCompletedDate: type: string description: The date on which this transfer was completed. format: date transferOfCareRequestId: type: string description: The primary key of this transfer of care request. transferReason: type: string description: The reason this transfer of care was requested. updatedAt: type: string description: The timestamp for update of the transfer request details. format: date-time updatedBy: type: string description: The id of the user who last updated the transfer request details. description: "" Osdk.TransferOfCareRequestProperties: type: string enum: - destinationCareServiceId - requestAcceptedDate - updatedBy - requestReceivedDate - transferOfCareRequestId - updatedAt - status - transferCompletedDate - transferReason - sourceAdmissionId - resultingAdmissionId - requestedByCareServiceId - requestCreatedDate Osdk.TrustSetting: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string name: type: string description: The name of the trust setting. 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 nullable: true items: type: string rvModules: type: array description: Deprecated property formerly used to set permissions nullable: true items: type: string trustSettingId: type: string description: The unique identifier for the trust setting. updatedBy: type: string description: The identifier of the user who last updated the trust setting. updatedTimestamp: type: string description: The timestamp indicating when the trust setting was last updated. format: date-time value: type: string description: The value associated with the trust setting. description: "" Osdk.TrustSettingProperties: type: string enum: - rvModules - updatedBy - name - updatedTimestamp - rvGroupIds - value - trustSettingId Osdk.UecAttendance: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string acuity: type: string description: A measure of the severity of the patient's condition and the urgency with which they need to be seen and assessed by a qualified clinician. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_acuity__snomed_ct_.html acuitySnomedCtCode: type: string description: A measure of the severity of the patient's condition and the urgency with which they need to be seen and assessed by a qualified clinician. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_acuity__snomed_ct_.html admissionId: type: string description: "A foreign key to the [CDM] Admission object type." ambulanceCallId: type: string description: A unique identifier for each Ambulance Call. https://www.datadictionary.nhs.uk/attributes/ambulance_call_identifier.html ambulanceIncidentId: type: string description: A unique identifier to each Ambulance Incident associated with the patient. https://www.datadictionary.nhs.uk/data_elements/care_contact_identifier__ambulance_service_.html arrivalMode: type: string description: The transport mode by which the patient arrived at the UEC site. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_arrival_mode__snomed_ct_.html arrivalModeSnomedCtCode: type: string description: The transport mode by which the patient arrived at the UEC site. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_arrival_mode__snomed_ct_.html arrivalTimestamp: type: string description: The timestamp the patient arrivel at the UEC site. https://www.datadictionary.nhs.uk/nhs_business_definitions/urgent_and_emergency_care_activity_start_date_and_time.html format: date-time attendanceSource: type: string description: The source of the attendance to the UEC site. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_attendance_source__snomed_ct_.html attendanceSourceSite: type: string description: The site from which the patient arrived at the UEC site. https://www.datadictionary.nhs.uk/data_elements/organisation_site_identifier__emergency_care_attendance_source_.html attendanceSourceSiteOdsCode: type: string description: The site from which the patient arrived at the UEC site. https://www.datadictionary.nhs.uk/data_elements/organisation_site_identifier__emergency_care_attendance_source_.html attendanceSourceSnomedCtCode: type: string description: The source of the attendance to the UEC site. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_attendance_source__snomed_ct_.html chiefComplaint: type: string description: The patient's chief complaint as assessed by the care professional first assessing the patient in ED. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_chief_complaint__snomed_ct_.html chiefComplaintSnomedCtCode: type: string description: The patient's chief complaint as assessed by the care professional first assessing the patient in ED. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_chief_complaint__snomed_ct_.html clinicallyReadyToProceedTimestamp: type: string description: The first timestamp that the care professional authorised to discharge the patient from ED makes a clinical decision that the patient no longer requires ongoing care in ED. https://www.datadictionary.nhs.uk/nhs_business_definitions/urgent_and_emergency_care_clinically_ready_to__proceed_timestamp.html format: date-time consultationMechanism: type: string description: The main way in which the UEC attendance was conducted by the responsible care professional. https://www.datadictionary.nhs.uk/data_elements/consultation_mechanism__urgent_and_emergency_care_.html consultationMechanismCode: type: string description: The main way in which the UEC attendance was conducted by the responsible care professional. https://www.datadictionary.nhs.uk/data_elements/consultation_mechanism__urgent_and_emergency_care_.html consultationMechanismLocalCode: type: string description: The main way in which the UEC attendance was conducted by the responsible care professional. conveyingAmbulanceTrust: type: string description: The trust whose ambulance services conveyed the patient. https://www.datadictionary.nhs.uk/data_elements/organisation_code__conveying_ambulance_trust_.html conveyingAmbulanceTrustOdsCode: type: string description: The trust whose ambulance services conveyed the patient. https://www.datadictionary.nhs.uk/data_elements/organisation_code__conveying_ambulance_trust_.html decisionToAdmitTimestamp: type: string description: The timestamp a decision to admit was made. https://www.datadictionary.nhs.uk/data_elements/decided_to_admit_date_and_time.html format: date-time departureTimestamp: type: string description: The timestamp the patient departed from the UEC site. https://www.datadictionary.nhs.uk/nhs_business_definitions/urgent_and_emergency_care_activity_end_timestamp.html format: date-time dischargeDestination: type: string description: The destination the patient was discharged to following the visit to ED. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_discharge_destination__snomed_ct_.html dischargeDestinationSnomedCtCode: type: string description: The destination the patient was discharged to following the visit to ED. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_discharge_destination__snomed_ct_.html dischargeFollowUp: type: string description: The service to which the patient was referred for continuing care following the visit to the emergency department. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_discharge_follow_up__snomed_ct_.html dischargeFollowUpSnomedCtCode: type: string description: The service to which the patient was referred for continuing care following the visit to the emergency department. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_discharge_follow_up__snomed_ct_.html dischargeSite: type: string description: The site to which the patient was discharged following the visit to ED. https://www.datadictionary.nhs.uk/data_elements/organisation_site_identifier__discharge_from_urgent_and_emergency_care_.html dischargeSiteOdsCode: type: string description: The site to which the patient was discharged following the visit to ED. https://www.datadictionary.nhs.uk/data_elements/organisation_site_identifier__discharge_from_urgent_and_emergency_care_.html dischargeStatus: type: string description: Describes the status of the patient on discharge from ED. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_discharge_status__snomed_ct_.html dischargeStatusSnomedCtCode: type: string description: Describes the status of the patient on discharge from ED. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_discharge_status__snomed_ct_.html edExtendedCareEpisodeId: type: string description: An identifier that uniquely identifies the extended care episode the attendance belongs to. https://www.datadictionary.nhs.uk/data_elements/urgent_and_emergency_care_extended_care_episode_identifier.html emergencyCareDepartmentType: type: string description: The type of emergency care department. https://www.datadictionary.nhs.uk/attributes/emergency_care_department_type.html emergencyCareDepartmentTypeCode: type: string description: The type of emergency care department. https://www.datadictionary.nhs.uk/attributes/emergency_care_department_type.html emergencyCareDepartmentTypeLocalCode: type: string description: The type of emergency care department. expectedTreatmentAllocationTimestamp: type: string description: The timestamp that an expected treatment timestamp was allocated to the patient. https://www.datadictionary.nhs.uk/data_elements/emergency_care_treatment_allocation_timestamp.html format: date-time expectedTreatmentTimestamp: type: string description: The timestamp the patient is expected to be treated. https://www.datadictionary.nhs.uk/nhs_business_definitions/emergency_care_expected_date_and_timestamp_of_treatment.html format: date-time hasDischargeInformationBeenGiven: type: boolean description: An indication of whether a copy of a letter to the patient's GP has been given to the patient on discharge from ED. https://www.datadictionary.nhs.uk/attributes/urgent_and_emergency_care_discharge_information_given_indicator.html healthcareProvider: type: string description: The organisation acting as the healthcare provider. https://www.datadictionary.nhs.uk/data_elements/organisation_code__code_of_provider_.html healthcareProviderOdsCode: type: string description: The organisation acting as the healthcare provider. https://www.datadictionary.nhs.uk/data_elements/organisation_code__code_of_provider_.html initialAssessmentTimestamp: type: string description: The timestamp the patient was first assessed in the UEC site. https://www.datadictionary.nhs.uk/nhs_business_definitions/emergency_care_initial_assessment_date.html format: date-time patientId: type: string description: "A foreign key to the [CDM] Patient object 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 nullable: true items: type: string safeguardingConcerns: type: array description: A list of concerns regarding the safeguarding of an adult or child. https://www.datadictionary.nhs.uk/data_elements/safeguarding_concern__snomed_ct_.html nullable: true items: type: string safeguardingConcernsSnomedCtCodes: type: array description: A list of concerns regarding the safeguarding of an adult or child. https://www.datadictionary.nhs.uk/data_elements/safeguarding_concern__snomed_ct_.html nullable: true items: type: string seenForTreatmentTimestamp: type: string description: The timestamp that the patient was seen by a clinical decision maker to diagnose the problem and arrange or start definite treatment as necessary. https://www.datadictionary.nhs.uk/nhs_business_definitions/urgent_and_emergency_care_timestamp_seen_for_treatment.html format: date-time treatmentSite: type: string description: The site the patient was treated at. https://www.datadictionary.nhs.uk/data_elements/organisation_site_identifier__of_treatment_.html treatmentSiteOdsCode: type: string description: The site the patient was treated at. https://www.datadictionary.nhs.uk/data_elements/organisation_site_identifier__of_treatment_.html uecAttendanceExternalId: type: string description: The external identifier for the UEC attendance. This should not be used as a foreign key. uecAttendanceId: type: string description: Primary key. urgentAndEmergencyCareAttendanceCategory: type: string description: "Distinguishes between unplanned first attendances for new\ \ or worsening conditions, unplanned follow-ups within 7 days at the same\ \ or different services, and planned follow-ups within 7 days at the same\ \ service. https://www.datadictionary.nhs.uk/attributes/urgent_and_emergency_care_attendance_category.html" urgentAndEmergencyCareAttendanceCategoryCode: type: string description: "Distinguishes between unplanned first attendances for new\ \ or worsening conditions, unplanned follow-ups within 7 days at the same\ \ or different services, and planned follow-ups within 7 days at the same\ \ service. https://www.datadictionary.nhs.uk/attributes/urgent_and_emergency_care_attendance_category.html" urgentAndEmergencyCareAttendanceCategoryLocalCode: type: string description: "Distinguishes between unplanned first attendances for new\ \ or worsening conditions, unplanned follow-ups within 7 days at the same\ \ or different services, and planned follow-ups within 7 days at the same\ \ service." description: "A visit to a UEC site such as an emergency department, SDEC, or\ \ UTC. https://www.datadictionary.nhs.uk/nhs_business_definitions/emergency_care_attendance.html" Osdk.UecAttendanceProperties: type: string enum: - seenForTreatmentTimestamp - conveyingAmbulanceTrustOdsCode - treatmentSite - dischargeDestinationSnomedCtCode - dischargeStatusSnomedCtCode - rvGroupIds - conveyingAmbulanceTrust - uecAttendanceExternalId - urgentAndEmergencyCareAttendanceCategory - arrivalMode - attendanceSourceSite - uecAttendanceId - hasDischargeInformationBeenGiven - dischargeFollowUpSnomedCtCode - ambulanceCallId - ambulanceIncidentId - dischargeSiteOdsCode - expectedTreatmentTimestamp - clinicallyReadyToProceedTimestamp - dischargeSite - urgentAndEmergencyCareAttendanceCategoryCode - patientId - attendanceSource - emergencyCareDepartmentTypeLocalCode - chiefComplaint - treatmentSiteOdsCode - safeguardingConcernsSnomedCtCodes - initialAssessmentTimestamp - attendanceSourceSiteOdsCode - emergencyCareDepartmentType - urgentAndEmergencyCareAttendanceCategoryLocalCode - expectedTreatmentAllocationTimestamp - healthcareProvider - acuity - consultationMechanism - decisionToAdmitTimestamp - admissionId - healthcareProviderOdsCode - edExtendedCareEpisodeId - consultationMechanismLocalCode - consultationMechanismCode - safeguardingConcerns - attendanceSourceSnomedCtCode - arrivalModeSnomedCtCode - dischargeStatus - chiefComplaintSnomedCtCode - dischargeDestination - emergencyCareDepartmentTypeCode - acuitySnomedCtCode - departureTimestamp - arrivalTimestamp - dischargeFollowUp Osdk.UecReferral: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string patientId: type: string description: Foreign key to the patient being referred. referralTimestamp: type: string description: The timestamp the referral was created. https://www.datadictionary.nhs.uk/data_elements/activity_service_request_date__emergency_care_.html format: date-time referredToService: type: string description: The service to which the patient was referred for admission or opinion by the treating care professional. https://www.datadictionary.nhs.uk/data_elements/referred_to_service__snomed_ct_.html referredToServiceAssessmentTimestamp: type: string description: The timestamp the service the patient has been referred to assesses the patient. https://www.datadictionary.nhs.uk/data_elements/referred_to_service_assessment_timestamp.html format: date-time referredToServiceSnomedCtCode: type: string description: The service to which the patient was referred for admission or opinion by the treating care professional. https://www.datadictionary.nhs.uk/data_elements/referred_to_service__snomed_ct_.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 nullable: true items: type: string uecAttendanceId: type: string description: Foreign key to the UEC attendance in which the referral was created. uecReferralId: type: string description: Primary key. description: A referral from UEC to a service. Osdk.UecReferralProperties: type: string enum: - uecAttendanceId - patientId - referredToServiceAssessmentTimestamp - rvGroupIds - referralTimestamp - referredToServiceSnomedCtCode - uecReferralId - referredToService Osdk.Url: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string displayName: type: string description: Display name for the URL to be shown as a button or link title for customisable urls moduleRelevance: type: string description: "The module this URL is applicable to. E.g. \"cancer\", \"\ inpatient\", \"outpatient\"" 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 nullable: true items: type: string updatedAt: type: string description: Timestamp of the most recent update format: date-time updatedBy: type: string description: The user who made the last update urLocator: type: string description: URL urlId: type: string description: ID description: "" Osdk.UrlProperties: type: string enum: - updatedBy - moduleRelevance - updatedAt - urlId - rvGroupIds - displayName - urLocator Osdk.UserPreference: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string cancerPathwayTags: type: array description: List of pathway tags that the users have selected as default filters nullable: true items: type: string cancerPathwayTypes: type: array description: List of pathway types that the users have selected as default filters nullable: true items: type: string cancerSites: type: array description: List of cancer sites that the users have selected as default filters nullable: true items: type: string defaultConsultants: type: array description: consultant nullable: true items: type: string defaultRole: type: string description: Default user role defaultSites: type: array description: site nullable: true items: type: string defaultSpecialties: type: array description: "Foregin key: specialty" nullable: true items: type: string notificationChannels: type: array description: notification channel nullable: true items: type: string receiveChangelogRequestNotifications: type: boolean description: Opt in to receive changelog request notifications receiveSchedulingNotifications: type: boolean description: Opt in to receive scheduling notifications receiveSchedulingUpdateNotifications: type: boolean description: Opt in to receive notifications when an update is made to a scheduling request the user has created receiveTheatreManagementNotifications: type: boolean description: Opt in to receive scheduling notifications userId: type: string description: multipass user id Osdk.UserPreferenceProperties: type: string enum: - defaultSpecialties - receiveSchedulingUpdateNotifications - defaultConsultants - defaultSites - notificationChannels - userId - receiveSchedulingNotifications - defaultRole - receiveTheatreManagementNotifications - receiveChangelogRequestNotifications - cancerPathwayTypes - cancerSites - cancerPathwayTags Osdk.ValidatedChangeLogComment: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string changeLogId: type: string description: ID of the validated changelog commentId: type: string description: ID of the comment commentMarkdown: type: string description: Markdown version of free text comment commentText: type: string description: String text of comment commentTimestamp: type: string description: Timestamp at creation of comment format: date-time commentUser: type: string description: Multipass user id of user creating comment taskAction: type: string description: Action taken when creating comment description: "" Osdk.ValidatedChangeLogCommentProperties: type: string enum: - commentMarkdown - changeLogId - commentText - commentTimestamp - commentId - commentUser - taskAction Osdk.ValidatedChangelog: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string actionType: type: string assignedTeamId: type: string description: ID of the team assigned to this task assignedTeamName: type: string description: Name of assigned team of this task assignedUserGroup: type: string assignedUserIds: type: array description: IDs of users assigned to this task nullable: true items: type: string careProfessionalId: type: string careProfessionalName: type: string changeLogId: type: string closedAt: type: string description: Timestamp when this task was closed format: date-time closedBy: type: string description: User who closed this task commentUser: type: string comments: type: string daysOpen: type: integer description: type: string ealId: type: string encounterId: type: string externalId: type: string freeTextComments: type: string isRtt: type: boolean lastRefreshed: type: string format: date-time mrn: type: string newValue: type: string originatingWaitingListAlertRuleTypes: type: array nullable: true items: type: string originatingWaitingListAlertUniqueIds: type: array nullable: true items: type: string patientId: type: string patientName: type: string preResolved: type: boolean primaryConsultantId: type: string primaryConsultantName: type: string primaryEvidenceSource: type: string priority: type: string propertyToModify: type: string rcsClinicalHarmReview: type: string removalDate: type: string format: date removed: type: boolean requestedBy: type: string requiredAction: type: string resolved: type: boolean secondaryEvidenceSource: type: array nullable: true items: type: string siteId: type: string specialtyId: type: string specialtyName: type: string status: type: string statusUpdatedByUser: type: string statusUpdatedTimestamp: type: string format: date-time taskDueDate: type: string description: Due date for this task format: date taskPriority: type: string description: "High, Medium, or Low" taskType: type: string description: Task type - this will always be 'Inpatient Change Request' timestamp: type: string format: date-time title: type: string unresolvedEncounterId: type: string validated: type: string ward: type: string description: "" Osdk.ValidatedChangelogProperties: type: string enum: - requiredAction - patientName - lastRefreshed - changeLogId - comments - primaryConsultantName - mrn - commentUser - removalDate - ealId - statusUpdatedByUser - statusUpdatedTimestamp - removed - taskType - assignedTeamName - description - ward - freeTextComments - unresolvedEncounterId - requestedBy - assignedUserIds - primaryConsultantId - patientId - preResolved - careProfessionalId - assignedUserGroup - closedBy - specialtyName - secondaryEvidenceSource - encounterId - resolved - assignedTeamId - primaryEvidenceSource - rcsClinicalHarmReview - closedAt - originatingWaitingListAlertUniqueIds - priority - newValue - status - taskPriority - specialtyId - daysOpen - actionType - propertyToModify - originatingWaitingListAlertRuleTypes - externalId - siteId - title - validated - timestamp - isRtt - taskDueDate - careProfessionalName Osdk.VirtualWard: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string closureDate: type: string description: The date the virtual ward closed. format: date isPointOfCareTestingAvailable: type: boolean description: A flag indicating whether point of care testing is available on the virtual ward. isTechnologyEnabled: type: boolean description: A flag indicating whether the virtual ward is technology enabled. maxCapacity: type: integer description: The maximum number of patients who could safely be managed simultaneously as part of a virtual ward service. openingDate: type: string description: The date the virtual ward opened. format: date primaryDataCollectionSystem: type: string description: The primary system used to collect data for the virtual ward. 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 nullable: true items: type: string trustOdsCode: type: string description: Trust ODS code. virtualWardCode: type: string description: A unique code identifying the virtual ward within the trust. virtualWardId: type: string description: Primary key. virtualWardName: type: string description: The name of the virtual ward. description: "" Osdk.VirtualWardProperties: type: string enum: - isTechnologyEnabled - isPointOfCareTestingAvailable - virtualWardCode - openingDate - primaryDataCollectionSystem - rvGroupIds - virtualWardId - maxCapacity - virtualWardName - closureDate - trustOdsCode Osdk.VirtualWardStay: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string activityLocationType: type: string description: The location where the PATIENT receives care during a Virtual Ward Stay. activityLocationTypeCode: type: string description: The location where the PATIENT receives care during a Virtual Ward Stay. admissionSource: type: string description: A classification which identifies the source of admission to the Virtual Ward. Please refer to virtual ward mds specification. https://digital.nhs.uk/about-nhs-digital/corporate-information-and-documents/directions-and-data-provision-notices/data-provision-notices-dpns/virtual-wards-minimum-data-set admissionSourceCode: type: string description: A classification which identifies the source of admission to the Virtual Ward. destinationOfDischarge: type: string description: The destination the patient was discharged to following the virtual ward stay. https://www.datadictionary.nhs.uk/data_elements/discharge_destination_code__hospital_provider_spell_.html?hl=destination%2Ccode%2Cdischarge destinationOfDischargeCode: type: string description: The destination the patient was discharged to following the virtual ward stay. endTimestamp: type: string description: The timestamp the virtual ward stay ended. format: date-time expectedCommissioner: type: string description: The organisation commissioning health care. https://www.datadictionary.nhs.uk/data_elements/organisation_identifier__code_of_commissioner_.html expectedCommissionerOdsCode: type: string description: The ODS code of the organisation commissioning health care. isPatientSubjectToRemoteMonitoring: type: boolean description: A flag indicating whether the patient is subject to remote monitoring during the virtual ward stay. methodOfDischarge: type: string description: The method of discharge from a Virtual Ward. https://www.datadictionary.nhs.uk/data_elements/method_of_discharge__hospital_provider_spell_.html?hl=method%2Cdischarge methodOfDischargeCode: type: string description: The method of discharge from a Virtual Ward. patientId: type: string description: "A foreign key to the [CDM] Patient object 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 nullable: true items: type: string startTimestamp: type: string description: The timestamp the virtual ward stay started. format: date-time trustOdsCode: type: string description: Trust ODS code. virtualWardId: type: string description: "A foreign key to the [CDM] Virtual Ward object type." virtualWardStayId: type: string description: Primary key. description: "" Osdk.VirtualWardStayProperties: type: string enum: - destinationOfDischarge - patientId - rvGroupIds - admissionSource - endTimestamp - methodOfDischargeCode - admissionSourceCode - trustOdsCode - methodOfDischarge - virtualWardStayId - destinationOfDischargeCode - expectedCommissioner - startTimestamp - activityLocationTypeCode - expectedCommissionerOdsCode - virtualWardId - activityLocationType - isPatientSubjectToRemoteMonitoring Osdk.Waitlist: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string 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 nullable: true items: type: string waitlistId: type: string description: Primary key for the waitlist. waitlistName: type: string description: The name of the waitlist. description: All operational waitlists that a Trusts manages and that waiting list entries can be on. Osdk.WaitlistEntry: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string addedTimestamp: type: string description: Timestamp when the entry was added to the waitlist. format: date-time dueDate: type: string description: Date by which the waitlist entry should be processed. format: date pathwayId: type: string description: Foreign key to the patient pathway. removedTimestamp: type: string description: Timestamp when the entry was removed from the waitlist. format: date-time 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 nullable: true items: type: string waitlistEntryId: type: string description: Primary key for the waitlist entry. waitlistId: type: string description: Foreign key to the waitlist. description: Generic entries on waitlists tracking patient placement and timing information. Encounters and instances of OP activity must have a corresponding waitlist entry. Osdk.WaitlistEntryProperties: type: string enum: - pathwayId - removedTimestamp - waitlistId - rvGroupIds - waitlistEntryId - addedTimestamp - dueDate Osdk.WaitlistProperties: type: string enum: - waitlistName - rvGroupIds - waitlistId Osdk.Ward: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string division: type: string description: The division the ward belongs 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 nullable: true items: type: string site: type: string description: The site the ward belongs to. https://www.datadictionary.nhs.uk/data_elements/organisation_site_identifier__of_ward_.html siteOdsCode: type: string description: The site the ward belongs to. https://www.datadictionary.nhs.uk/data_elements/organisation_site_identifier__of_ward_.html trust: type: string description: The name of the trust the ward belongs to. trustOdsCode: type: string description: The ODS code of the trust the ward belongs to. wardCode: type: string description: A unique identifier for the ward within the trust. https://www.datadictionary.nhs.uk/attributes/ward_code.html wardId: type: string description: Primary key. wardIntendedAgeGroup: type: string description: "The age group of patients intended to use the ward, as indicated\ \ in the ward operational plan. https://www.datadictionary.nhs.uk/attributes/ward_intended_age_group.html" wardIntendedAgeGroupCode: type: string description: "The age group of patients intended to use the ward, as indicated\ \ in the ward operational plan. https://www.datadictionary.nhs.uk/attributes/ward_intended_age_group.html" wardIntendedAgeGroupLocalCode: type: string description: "The age group of patients intended to use the ward, as indicated\ \ in the ward operational plan." wardIntendedClinicalCareIntensity: type: string description: The level of resources and intensity of care which is intended to be provided by the ward. https://www.datadictionary.nhs.uk/attributes/ward_intended_clinical_care_intensity.html wardIntendedClinicalCareIntensityCode: type: string description: The level of resources and intensity of care which is intended to be provided by the ward. https://www.datadictionary.nhs.uk/attributes/ward_intended_clinical_care_intensity.html wardIntendedClinicalCareIntensityLocalCode: type: string description: The level of resources and intensity of care which is intended to be provided by the ward. wardIntendedDayPeriodAvailabilityDays: type: integer description: "The number of day periods in a week that it is intended the\ \ ward should be available, as indicated in the ward operational plan.\ \ https://www.datadictionary.nhs.uk/attributes/ward_intended_day_period_availability.html" wardIntendedNightPeriodAvailabilityDays: type: integer description: "The number of night periods in a week that it is intended\ \ the ward should be available, as indicated in the ward operational plan.\ \ https://www.datadictionary.nhs.uk/attributes/ward_intended_night_period_availability.html" wardIntendedSexOfPatients: type: string description: "The sex of patients intended to use the ward, as indicated\ \ in the ward operational plan. https://www.datadictionary.nhs.uk/attributes/ward_intended_sex_of_patients.html" wardIntendedSexOfPatientsCode: type: string description: "The sex of patients intended to use the ward, as indicated\ \ in the ward operational plan. https://www.datadictionary.nhs.uk/attributes/ward_intended_sex_of_patients.html" wardIntendedSexOfPatientsLocalCode: type: string description: "The sex of patients intended to use the ward, as indicated\ \ in the ward operational plan." wardName: type: string description: The full name of the ward. wardSecurityLevel: type: string description: The security level of the ward. https://www.datadictionary.nhs.uk/attributes/ward_security_level.html wardSecurityLevelCode: type: string description: The security level of the ward. https://www.datadictionary.nhs.uk/attributes/ward_security_level.html wardSecurityLevelLocalCode: type: string description: The security level of the ward. description: A group of Hospital Beds with associated treatment facilities managed as a single unit for the purposes of staffing and treatment responsibilities. https://www.datadictionary.nhs.uk/classes/ward.html Osdk.WardProperties: type: string enum: - wardIntendedClinicalCareIntensityCode - wardId - wardSecurityLevelLocalCode - wardIntendedNightPeriodAvailabilityDays - wardSecurityLevel - wardIntendedAgeGroupCode - trust - wardIntendedSexOfPatients - rvGroupIds - division - trustOdsCode - wardIntendedSexOfPatientsCode - site - siteOdsCode - wardName - wardIntendedSexOfPatientsLocalCode - wardIntendedAgeGroup - wardCode - wardIntendedClinicalCareIntensity - wardSecurityLevelCode - wardIntendedAgeGroupLocalCode - wardIntendedClinicalCareIntensityLocalCode - wardIntendedDayPeriodAvailabilityDays Osdk.WardStay: required: - __apiName - __primaryKey type: object properties: __apiName: type: string __primaryKey: type: string __rid: type: string admissionId: type: string description: A foreign key to the admission this ward stay belongs to. endTimestamp: type: string description: The timestamp the patient ended staying in the ward. https://www.datadictionary.nhs.uk/data_elements/end_date__ward_stay_.html format: date-time patientId: type: string description: A foreign key to the patient staying in the ward. 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 nullable: true items: type: string startTimestamp: type: string description: The timestamp the patient started staying in the ward. https://www.datadictionary.nhs.uk/data_elements/start_date__ward_stay_.html format: date-time wardId: type: string description: A foreign key to the ward the patient is staying in. wardStayId: type: string description: Primary key. description: "A period of time when a patient is using a hospital bed and/or\ \ using a delivery facility, stays in a ward. https://www.datadictionary.nhs.uk/nhs_business_definitions/ward_stay.html" Osdk.WardStayProperties: type: string enum: - patientId - wardId - startTimestamp - admissionId - rvGroupIds - endTimestamp - wardStayId OutpatientActivity.CareProfessional: type: object properties: careProfessionalId: type: string careProfessionalLocalId: type: string isActive: type: boolean localSubSpecialties: type: array nullable: true items: type: string mainSpecialty: type: string mainSpecialtyCode: type: string name: type: string professionalRegistrationBody: type: string professionalRegistrationBodyCode: type: string professionalRegistrationEntryId: type: string role: type: string rvGroupIds: type: array nullable: true items: type: string OutpatientActivity.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string OutpatientActivity.PatientPathway: type: object properties: _104WeeksBreachDate: type: string format: date _18WeeksBreachDate: type: string format: date _52WeeksBreachDate: type: string format: date _65WeeksBreachDate: type: string format: date _78WeeksBreachDate: type: string format: date accessibilityFlags: type: array nullable: true items: type: string admissionMethodCode: type: string age: type: string format: long closureReason: type: string consultantId: type: string consultantName: type: string covidPriority: type: string covidPriorityDate: type: string format: date dataSource: type: string dateOfBirth: type: string format: date daysTo104WeekBreachDate: type: integer daysTo18WeekBreachDate: type: integer daysTo52WeekBreachDate: type: integer daysTo65WeekBreachDate: type: integer daysTo78WeekBreachDate: type: integer derivedPathwayType: type: string directorate: type: string division: type: string dtaDate: type: string format: date intendedProcedureDescription: type: string isActiveRttPathway: type: boolean isOpenPathway: type: boolean 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 latestEpisodeId: type: string latestPathwayStatusCodeNational: type: string latestPathwayStatusDescriptionNational: type: string latestPeriodEndDate: type: string format: date latestPeriodEndReason: type: string latestPeriodLengthDays: type: integer latestPeriodLengthWeeks: type: integer latestPeriodStartDate: type: string format: date latestPeriodStartReason: type: string latestProcedurePriorityCode: type: string latestReferralReceivedDate: type: string format: date latestRttPeriodId: type: string 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 originalReferralSpecialtyId: type: string originalReferralSpecialtyName: type: string owlClinicCode: type: string owlFlag: type: boolean owlGroupCode: type: string pathwayClass: type: string pathwayEndDate: type: string format: date pathwayId: type: string pathwayStage: type: string pathwayStartDate: type: string format: date pathwayStatus: type: string pathwaySubtype: type: string pathwayType: type: string patientDeceased: type: boolean patientId: type: string patientName: type: string ppid: type: string ppidIssuer: type: string ppidIssuerOdsCode: type: string prospectiveRttPeriodEndDate: type: string format: date prospectiveRttWeeksWait: type: integer referralDate: type: string format: date referralId: type: string referralPriority: type: string referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true 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 waitingTimeMeasurementType: type: string waitingTimeMeasurementTypeCode: type: string waitingTimeMeasurementTypeCodeLocalCode: type: string weeksTo104WeekBreachDate: type: integer weeksTo18WeekBreachDate: type: integer weeksTo52WeekBreachDate: type: integer weeksTo65WeekBreachDate: type: integer weeksTo78WeekBreachDate: type: integer weeksWaitSinceDtaDate: type: integer weeksWaitSinceLastPatientContact: type: integer weeksWaitToProspectiveRttPeriodEndDate: type: integer weeksWaitToTciDate: type: integer OutpatientActivity.Referral: 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 isReferralToVirtualWard: type: boolean mrn: type: string pathwayId: type: array nullable: true items: type: string patientId: type: string patientIsOnCancerPathway: type: boolean presentingComplaint: type: string presentingComplaintIcd10Code: type: string presentingComplaintSnomedCtCode: type: string primaryCareProfessionalId: type: string primaryReferralReason: type: string primaryReferralReasonCode: type: string primaryReferralReasonToVirtualWardCode: type: string priority: type: string priorityCode: type: string priorityLocalCode: type: string referralId: type: string referralLetterContent: type: string referralLetterRid: $ref: "#/components/schemas/Core.MediaReference" referralNotes: type: string referralReceivedTimestamp: type: string format: date-time referralRejectionReason: type: string referralRejectionReasonCode: type: string referralRejectionTimestamp: type: string format: date-time referralSource: type: string referralSourceCode: type: string referralSourceLocalCode: type: string referralType: type: string referrerId: type: string referringOrganisation: type: string referringOrganisationOdsCode: type: string removed: type: boolean removedTimestamp: type: string format: date-time requestedAppointmentType: type: string requestedConsultationMechanism: type: string rttPathwayStatus: type: string rttPeriodEndDate: type: string format: date rttPeriodLength: type: integer rttPeriodStartDate: type: string format: date rvGroupIds: type: array nullable: true items: type: string serviceId: type: string serviceName: type: string serviceType: type: string serviceTypeRequested: type: string serviceTypeRequestedCode: type: string serviceTypeRequestedLocalCode: 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 treatmentFunction: type: string treatmentFunctionCode: type: string treatmentFunctionLocalCode: type: string trustOdsCode: type: string ubrn: type: string wasPatientReferredToDirectAccessService: type: boolean wasReferredByFirstContactPractitioner: type: boolean weeksWaiting: type: integer OutpatientActivity.Specialty: type: object properties: isActiveSpecialty: type: boolean rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string theatreSpecialty: type: boolean OutpatientActivity.WaitlistEntry: type: object properties: addedTimestamp: type: string format: date-time dueDate: type: string format: date pathwayId: type: string removedTimestamp: type: string format: date-time rvGroupIds: type: array nullable: true items: type: string waitlistEntryId: type: string waitlistId: type: string OverseasVisitorChargingCategoryPeriod.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Patient.Admission: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string admissionExternalId: type: string admissionId: type: string admissionMethod: type: string admissionSource: type: string admissionSourceCode: type: string admissionSourceLocalCode: type: string admissionStatus: type: string admissionTimestamp: type: string format: date-time admissionTitle: type: string admissionType: type: string bedLocation: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string destinationOfDischargeLocalCode: type: string dischargeDestinationType: type: string dischargePathway: type: string dischargeReadyDate: type: string format: date dischargeTimestamp: type: string format: date-time ealEntryId: type: string encounterId: type: string estimatedDischargeDate: type: string format: date-time isDischargeTimeConfirmed: type: boolean localAuthority: type: string methodOfAdmission: type: string methodOfAdmissionCode: type: string methodOfAdmissionLocalCode: type: string methodOfDischarge: type: string methodOfDischargeCode: type: string methodOfDischargeLocalCode: type: string pathwayId: type: string patientClassification: type: string patientClassificationCode: type: string patientClassificationLocalCode: type: string patientId: type: string patientName: type: string rvGroupIds: type: array nullable: true items: type: string siteName: type: string specialtyId: type: string specialtyName: type: string startTimestamp: type: string format: date-time treatmentFunctionCode: type: string ward: type: string wasPatientDischargedToNhsAtHomeService: type: boolean Patient.Appointment: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string appointmentBookedReason: type: string appointmentBookedReasonCode: type: string appointmentBookedReasonLocalCode: type: string appointmentFreeText: type: string attendanceId: type: string attendanceStatus: type: string attendanceStatusCode: type: string attendanceStatusLocalCode: type: string bookedBy: type: string bookedDuration: type: integer bookingStatus: type: string cancellationReason: type: string cancelledBy: type: string cancerPriorityOrdering: type: integer category: type: string clinicId: type: string code: type: string consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string dateTimeBooked: type: string format: date-time dateTimeCancelled: type: string format: date-time earliestClinicallyAppropriateDate: type: string format: date earliestReasonableOfferDate: type: string format: date endDateTime: type: string format: date-time hasDateInTheLastNDays: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string isDateTimeBookedInTheLastNDays: type: boolean isDateTimeCancelledInTheLastNDays: type: boolean isFirstAppointment: type: boolean isOrderedDateInTheLastNDays: type: boolean isPoaAppointment: type: boolean isStartDateTimeInTheLastNDays: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time latestClinicallyAppropriateDate: type: string format: date orderedDate: type: string format: date outcomeOfAttendance: type: string outcomeOfAttendanceCode: type: string outcomeOfAttendanceLocalCode: type: string pathwayId: type: string 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 nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string startDateTime: type: string format: date-time treatmentFunctionCode: type: string treatmentFunctionLocalCode: type: string treatmentFunctionName: type: string type: type: string wasPatientOnPifuPathway: type: boolean wasPatientSubjectToRemoteMontitoring: type: boolean Patient.Birth: type: object properties: admissionId: type: string babyPatientId: type: string birthId: type: string birthSequenceNumber: type: integer birthWeightGrams: type: integer deliveryMethod: type: string deliveryMethodCode: type: string deliveryMethodLocalCode: type: string gestationLengthWeeks: type: integer isStillBirth: type: boolean labourId: type: string liveOrStillBirth: type: string liveOrStillBirthCode: type: string liveOrStillBirthLocalCode: type: string pregnancyId: type: string resuscitationMethod: type: string resuscitationMethodCode: type: string resuscitationMethodLocalCode: type: string rvGroupIds: type: array nullable: true items: type: string statusOfPersonConductingDelivery: type: string statusOfPersonConductingDeliveryCode: type: string statusOfPersonConductingDeliveryLocalCode: type: string Patient.BookingRequest: type: object properties: action: type: string amPm: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserGroup: type: string assignedUserIds: type: array nullable: true items: type: string bookingRequestId: type: string closedAt: type: string format: date-time closedBy: type: string comment: type: string consultantId: type: string date: type: string format: date encounterEstimatedTotalTheatreTime: type: integer encounterId: type: string intendedPrimaryProcedureDescription: type: string intendedPrimaryProcedureFreeText: type: string mnemonic: type: string mrn: type: string personId: type: string reason: type: string specialtyId: type: string status: type: string taskDueDate: type: string format: date taskPriority: type: string taskType: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreName: type: string theatreSessionId: type: string theatreSessionPlannedDurationMinutes: type: integer theatreSessionPrimaryConsultantId: type: string timestamp: type: string format: date-time title: type: string type: type: string updatedAt: type: string format: date-time updatedBy: type: string userId: type: string Patient.CancerPathway: type: object properties: _24DayBreachDate: type: string format: date _28DayBreachDate: type: string format: date _31DayBreachDate: type: string format: date _62DayBreachDate: type: string format: date adjustedPathwayStartDate: type: string format: date birthDate: type: string format: date cancerPathwayId: type: string cancerSite: type: string cancerSubSite: type: string daysSinceAdjustedPathwayStart: type: integer daysSinceAdjustedPathwayStartBucket: type: string deathDate: type: string format: date decisionToTreatDate: type: string format: date diagnosis: type: string diagnosisDate: type: string format: date diagnosisIcd10Code: type: string firstName: type: string firstSeenDate: type: string format: date firstSeenSite: type: string firstSeenSiteOdsCode: type: string firstTreatmentDate: type: string format: date firstTreatmentType: type: string fullName: type: string hospitalSite: type: string hospitalSiteId: type: string is28DayPathwayOpen: type: boolean is31DayPathwayOpen: type: boolean is62DayPathwayOpen: type: boolean isAnyPathwayTypeOpen: type: boolean isBenign: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time mrn: type: string nhsNumber: type: string organisationSiteTreatment: type: string originalPathwayStartDate: type: string format: date pathwayClosedDate: type: string format: date pathwayStatus: type: string pathwayType: type: string patientId: type: string patientInformedDate: type: string format: date referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string surname: type: string title: type: string treatmentSite: type: string treatmentSiteOdsCode: type: string treatmentType: type: string upgradeDate: type: string format: date waitingTimeAdjustmentDays: type: integer Patient.CancerTreatment: type: object properties: attendedDate: type: string format: date cancerPriorityOrdering: type: integer cancerTreatmentId: type: string cleanTreatmentStatus: type: string hasDateInTheLastNDays: type: boolean isAttendedDateInTheLastNDays: type: boolean isOrderedDateInTheLastNDays: type: boolean isScheduledDateInTheLastNDays: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time orderedDate: type: string format: date patientId: type: string rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string scheduledDate: type: string format: date sourceSystemNames: type: array nullable: true items: type: string treatmentDescription: type: string treatmentStatus: type: string treatmentType: type: string Patient.ClinicLetter: type: object properties: appointmentId: type: string clinicLetterDate: type: string format: date-time clinicLetterId: type: string clinicLetterType: type: string consultantId: type: string hasLetterContent: type: boolean letterContent: type: string letterRid: $ref: "#/components/schemas/Core.MediaReference" patientId: type: string rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string status: type: string Patient.Comorbidity: type: object properties: comorbidity: type: string comorbidityIcd10Code: type: string comorbidityId: type: string comorbiditySnomedCtCode: type: string patientId: type: string recordedEndDate: type: string format: date recordedStartDate: type: string format: date rvGroupIds: type: array nullable: true items: type: string Patient.ConsultantEpisode: type: object properties: admissionId: type: string consultantEpisodeExternalId: type: string consultantEpisodeId: type: string consultantEpisodeSequenceNumber: type: integer endTimestamp: type: string format: date-time healthcareProvider: type: string healthcareProviderOdsCode: type: string patientId: type: string psychiatricPatientStatus: type: string psychiatricPatientStatusCode: type: string psychiatricPatientStatusLocalCode: type: string rehabilitationAssessmentTeamType: type: string rehabilitationAssessmentTeamTypeCode: type: string rehabilitationAssessmentTeamTypeLocalCode: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time totalNumberOfRehabilitationDays: type: integer totalNumberOfSpecialistPalliativeCareDays: type: integer treatmentFunction: type: string treatmentFunctionCode: type: string Patient.CriticalCarePeriod: type: object properties: admissionId: type: string criticalCareAdmissionSource: type: string criticalCareAdmissionSourceCode: type: string criticalCareAdmissionSourceLocalCode: type: string criticalCareAdmissionType: type: string criticalCareAdmissionTypeCode: type: string criticalCareAdmissionTypeLocalCode: type: string criticalCareDischargeDestination: type: string criticalCareDischargeDestinationCode: type: string criticalCareDischargeDestinationLocalCode: type: string criticalCareDischargeLocation: type: string criticalCareDischargeLocationCode: type: string criticalCareDischargeLocationLocalCode: type: string criticalCareDischargeStatus: type: string criticalCareDischargeStatusCode: type: string criticalCareDischargeStatusLocalCode: type: string criticalCarePeriodId: type: string criticalCarePeriodType: type: string criticalCareSourceLocation: type: string criticalCareSourceLocationCode: type: string criticalCareSourceLocationLocalCode: type: string criticalCareUnitFunction: type: string criticalCareUnitFunctionCode: type: string criticalCareUnitFunctionLocalCode: type: string dischargeTimestamp: type: string format: date-time maxNumberOfOrganSystemsSupportedOnOneDay: type: integer patientId: type: string readyForDischargeTimestamp: type: string format: date-time rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time totalNumberOfAdvancedCardiovascularSupportDays: type: integer totalNumberOfAdvancedRespiratorySupportDays: type: integer totalNumberOfBasicCardiovascularSupportDays: type: integer totalNumberOfBasicRespiratorySupportDays: type: integer totalNumberOfDermatologicalSupportDays: type: integer totalNumberOfGastrointestinalSupportDays: type: integer totalNumberOfLevel2CareDays: type: integer totalNumberOfLevel3CareDays: type: integer totalNumberOfLiverSupportDays: type: integer totalNumberOfNeurologicalSupportDays: type: integer totalNumberOfRenalSupportDays: type: integer unitBedConfiguration: type: string unitBedConfigurationCode: type: string unitBedConfigurationLocalCode: type: string Patient.DiagnosticsWaitlistEntry: 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 nullable: true items: type: string sixWeekBreachDate: type: string format: date specialtyId: type: string Patient.EMed3FitNote: type: object properties: admissionId: type: string applicablePeriodDurationDays: type: integer appointmentId: type: string assessmentDate: type: string format: date condition: type: string conditionIcd10Code: type: string conditionSnomedCtCode: type: string emed3FitNoteId: type: string emed3FitNoteIssuer: type: string emed3FitNoteIssuerCode: type: string emed3FitNoteIssuerLocalCode: type: string endDate: type: string format: date isFollowUpAssessmentRequired: type: boolean patientId: type: string recordedDate: type: string format: date rvGroupIds: type: array nullable: true items: type: string startDate: type: string format: date uecAttendanceId: type: string Patient.EalEntry: 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 earliestClinicallyAppropriateDate: type: string format: date earliestReasonableOfferDate: type: string format: date episodeId: type: string hasRttPathwayDescription: type: string intendedManagement: type: string intendedManagementCode: type: string intendedManagementLocalCode: type: string isRtt: type: boolean latestClinicallyAppropriateDate: type: string format: date 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 nullable: true items: type: string title: type: string Patient.Encounter: type: object properties: administrativeCategoryCode: type: string administrativeCategoryDescription: type: string admissionMethod: type: string admissionOfferTimestamp: type: string format: date-time admissionStatus: type: string admissionSubStatus: type: string admissionType: type: string atsTotalTheatreTime: type: integer calculatedTotalTheatreTime: type: integer cancerPriorityOrdering: type: integer createdBy: type: string createdDate: type: string format: date criticalCareBedStatus: type: string division: type: string ealId: type: string encounterFreeText: type: string encounterId: type: string encounterType: type: string estimatedTotalTheatreTime: type: integer externalId: type: string genericWaitlistEntryId: type: string hasDateInTheLastNDays: type: boolean 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 isAdmissionOfferTimestampInTheLastNDays: type: boolean isBooked: type: boolean isMetricEncounter: type: boolean isSuitableForPooledList: type: boolean isSurgicalOrderDateInTheLastNDays: type: boolean isTciDateInTheLastNDays: type: boolean issues: type: array nullable: true items: type: string lastCovidSwabBookingStatus: type: string lastCovidSwabOutcome: type: string lastMrsaSwabBookingStatus: type: string lastMrsaSwabOutcome: type: string lastPoaBookingStatus: type: string lastPoaExpiryDate: type: string format: date lastPoaOutcome: type: string lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string lastPoaScheduledOrAttendedDatetime: type: string format: date-time lastRefreshedAtSourceTimestamp: 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 periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string site: type: string siteId: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string surgicalOrderDate: type: string format: date 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 Patient.Endoscopy: type: object properties: attendedDate: type: string format: date cancerPriorityOrdering: type: integer cleanStatus: type: string endoscopyExamId: type: string endoscopyExamType: type: string endoscopyPriority: type: string examStatus: type: string hasDateInTheLastNDays: type: boolean isAttendedDateInTheLastNDays: type: boolean isOrderedDateInTheLastNDays: type: boolean isReportAuthorisedDateInTheLastNDays: type: boolean isReportPreparedDateInTheLastNDays: type: boolean isReported: type: boolean isScheduledDateInTheLastNDays: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time modality: type: string orderedDate: type: string format: date patientId: type: string reportAuthorisedDate: type: string format: date reportPreparedDate: type: string format: date reportText: type: string rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string scheduledDate: type: string format: date sourceSystemNames: type: array nullable: true items: type: string Patient.GpPracticeRegistration: type: object properties: addressCity: type: string addressLine1: type: string addressLine2: type: string generalMedicalPractice: type: string generalMedicalPracticeId: type: string generalMedicalPracticeOdsCode: type: string icbOrganisationId: type: string isLatestRegistration: type: boolean namedGeneralPractitionerFirstName: type: string namedGeneralPractitionerId: type: string namedGeneralPractitionerLastName: type: string namedGeneralPractitionerPpdCode: type: string patientId: type: string postcode: type: string registrationEndDate: type: string format: date registrationId: type: string registrationStartDate: type: string format: date rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string subIcbLocationOrganisationId: type: string Patient.Histology: type: object properties: cancerPriorityOrdering: type: integer cleanStatus: type: string hasDateInTheLastNDays: type: boolean histologyId: type: string histologyPriority: type: string histologyStatus: type: string histologyType: type: string isReceivedAtLabDateInTheLastNDays: type: boolean isReportAuthorisedDateInTheLastNDays: type: boolean isReportPreparedDateInTheLastNDays: type: boolean isReported: type: boolean isSamplePreparedDateInTheLastNDays: type: boolean isSampleTakenDateInTheLastNDays: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time patientId: type: string receivedAtLabDate: type: string format: date reportAuthorisedDate: type: string format: date reportPreparedDate: type: string format: date reportText: type: string rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string samplePreparedDate: type: string format: date sampleTakenDate: type: string format: date sourceSystemNames: type: array nullable: true items: type: string Patient.HomeLeave: type: object properties: admissionId: type: string consultantEpisodeId: type: string endTimestamp: type: string format: date-time homeLeaveId: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time Patient.Injury: type: object properties: alcoholOrDrugInvolvementSnomedCtCodes: type: array nullable: true items: type: string alcoholOrDrugInvolvements: type: array nullable: true items: type: string assaultLocationDescription: type: string injuryActivityStatus: type: string injuryActivityStatusSnomedCtCode: type: string injuryActivityType: type: string injuryActivityTypeSnomedCtCode: type: string injuryId: type: string injuryIntent: type: string injuryIntentSnomedCtCode: type: string injuryMechanism: type: string injuryMechanismSnomedCtCode: type: string injuryTimestamp: type: string format: date-time patientId: type: string placeOfInjury: type: string placeOfInjuryLatitudeDegrees: type: number format: double placeOfInjuryLongitudeDegrees: type: number format: double placeOfInjurySnomedCtCode: type: string rvGroupIds: type: array nullable: true items: type: string uecAttendanceId: type: string Patient.InterProviderTransfer: type: object properties: cancerPathwayId: type: string cancerPathwayIptDate: type: string format: date interProviderTransferId: type: string iptReason: type: string iptReceivedDate: type: string format: date iptReturnedComment: type: string iptReturnedDate: type: string format: date iptSentComment: type: string iptSentDate: type: string format: date iptSentOrReceived: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time mrn: type: string nhsNumber: type: string patientId: type: string receivingOrgName: type: string receivingOrgOdsCode: type: string rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string sendingOrg: type: string sendingOrgOdsCode: type: string sourceSystemNames: type: array nullable: true items: type: string Patient.MentalHealthActLegalStatus: type: object properties: expiryTimestamp: type: string format: date-time mentalHealthActLegalStatusClassification: type: string mentalHealthActLegalStatusClassificationCode: type: string mentalHealthActLegalStatusClassificationCodeLocalCode: type: string mentalHealthActLegalStatusId: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time Patient.OutpatientActivity: 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 genericWaitlistEntryId: type: string isPrivate: type: boolean isReferral: type: boolean issues: type: array nullable: true 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 nullable: true 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.OverseasVisitorChargingCategoryPeriod: type: object properties: applicableEndDate: type: string format: date applicableFromDate: type: string format: date overseasVisitorChargingCategory: type: string overseasVisitorChargingCategoryCode: type: string overseasVisitorChargingCategoryLocalCode: type: string overseasVisitorChargingCategoryPeriodId: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string Patient.PatientAddressHistory: type: object properties: address: type: string city: type: string country: type: string county: type: string endDate: type: string format: date patientAddressHistoryId: type: string patientId: type: string postcode: type: string residenceResponsibility: type: string residenceResponsibilityOdsCode: type: string rvGroupIds: type: array nullable: true items: type: string startDate: type: string format: date Patient.PatientDiagnosis: type: object properties: active: type: string admissionId: type: string consultantEpisodeId: type: string diagnosisEndDate: type: string format: date diagnosisIcd10Code: type: string diagnosisId: type: string diagnosisName: type: string diagnosisSnomedCtCode: type: string diagnosisStartDate: type: string format: date diagnosisTimestamp: type: string format: date-time encounterId: type: string isPrimaryDiagnosis: type: boolean patientId: type: string patientPathwayId: type: string rvGroupIds: type: array nullable: true items: type: string uecAttendanceId: type: string virtualWardStayId: type: string Patient.PatientPathway: type: object properties: _104WeeksBreachDate: type: string format: date _18WeeksBreachDate: type: string format: date _52WeeksBreachDate: type: string format: date _65WeeksBreachDate: type: string format: date _78WeeksBreachDate: type: string format: date accessibilityFlags: type: array nullable: true items: type: string admissionMethodCode: type: string age: type: string format: long closureReason: type: string consultantId: type: string consultantName: type: string covidPriority: type: string covidPriorityDate: type: string format: date dataSource: type: string dateOfBirth: type: string format: date daysTo104WeekBreachDate: type: integer daysTo18WeekBreachDate: type: integer daysTo52WeekBreachDate: type: integer daysTo65WeekBreachDate: type: integer daysTo78WeekBreachDate: type: integer derivedPathwayType: type: string directorate: type: string division: type: string dtaDate: type: string format: date intendedProcedureDescription: type: string isActiveRttPathway: type: boolean isOpenPathway: type: boolean 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 latestEpisodeId: type: string latestPathwayStatusCodeNational: type: string latestPathwayStatusDescriptionNational: type: string latestPeriodEndDate: type: string format: date latestPeriodEndReason: type: string latestPeriodLengthDays: type: integer latestPeriodLengthWeeks: type: integer latestPeriodStartDate: type: string format: date latestPeriodStartReason: type: string latestProcedurePriorityCode: type: string latestReferralReceivedDate: type: string format: date latestRttPeriodId: type: string 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 originalReferralSpecialtyId: type: string originalReferralSpecialtyName: type: string owlClinicCode: type: string owlFlag: type: boolean owlGroupCode: type: string pathwayClass: type: string pathwayEndDate: type: string format: date pathwayId: type: string pathwayStage: type: string pathwayStartDate: type: string format: date pathwayStatus: type: string pathwaySubtype: type: string pathwayType: type: string patientDeceased: type: boolean patientId: type: string patientName: type: string ppid: type: string ppidIssuer: type: string ppidIssuerOdsCode: type: string prospectiveRttPeriodEndDate: type: string format: date prospectiveRttWeeksWait: type: integer referralDate: type: string format: date referralId: type: string referralPriority: type: string referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true 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 waitingTimeMeasurementType: type: string waitingTimeMeasurementTypeCode: type: string waitingTimeMeasurementTypeCodeLocalCode: type: string weeksTo104WeekBreachDate: type: integer weeksTo18WeekBreachDate: type: integer weeksTo52WeekBreachDate: type: integer weeksTo65WeekBreachDate: type: integer weeksTo78WeekBreachDate: type: integer weeksWaitSinceDtaDate: type: integer weeksWaitSinceLastPatientContact: type: integer weeksWaitToProspectiveRttPeriodEndDate: type: integer weeksWaitToTciDate: type: integer Patient.Pregnancy: type: object properties: antenatalResponsibleGpCareProfessionalId: type: string firstAntenatalAssessmentDate: type: string format: date intendedDeliveryPlace: type: string intendedDeliveryPlaceCode: type: string intendedDeliveryPlaceCodeLocalCode: type: string numberOfPreviousPregnanciesResultingInRegistrableBirths: type: integer patientId: type: string pregnancyId: type: string rvGroupIds: type: array nullable: true items: type: string Patient.Procedure: type: object properties: actualProcedureTimeKnifeToSkinClosure: type: integer actualProcedureTimeTotalTheatreTime: type: integer admissionId: type: string admissionMethodDescription: type: string anaestheticTypeToBeUsed: type: string anaesthetistRequired: type: boolean appointmentId: type: string consultantEpisodeId: type: string 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 procedure: type: string procedureDate: type: string format: date procedureId: type: string procedureOpcsCode: type: string procedureOrdered: type: integer procedureSnomedCtCode: type: string procedureTimeOrOrder: type: string procedureTimestamp: type: string format: date-time responsibleAnaesthetistCareProfessionalId: type: string rvGroupIds: type: array nullable: true items: type: string theatreSessionId: type: string title: type: string uecAttendanceId: type: string virtualWardStayId: type: string Patient.ProcedureStatus: 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 poaExpiryDate: type: string format: date poaOrdering: type: integer poaOutcome: type: string poaOutcomeDate: type: string format: date poaOutcomeFreeText: type: string poaScheduledOrAttendedDatetime: type: string format: date-time procedureId: type: string procedureStatusId: type: string rvGroupIds: type: array nullable: true items: type: string theatreBookingId: type: string Patient.RadiologyExam: type: object properties: attendedDate: type: string format: date cancerPriorityOrdering: type: integer cleanExamStatus: type: string examStatus: type: string hasDateInTheLastNDays: type: boolean isAttendedDateInTheLastNDays: type: boolean isOrderedDateInTheLastNDays: type: boolean isReportAuthorisedDateInTheLastNDays: type: boolean isReportPreparedDateInTheLastNDays: type: boolean isReported: type: boolean isScheduledDateInTheLastNDays: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time modality: type: string orderedDate: type: string format: date patientId: type: string radiologyExamId: type: string radiologyExamType: type: string radiologyPriority: type: string reportAuthorisedDate: type: string format: date reportPreparedDate: type: string format: date reportText: type: string rvGroupIds: type: array nullable: true items: type: string rvModules: type: array nullable: true items: type: string scheduledDate: type: string format: date sourceSystemNames: type: array nullable: true items: type: string Patient.Referral: 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 isReferralToVirtualWard: type: boolean mrn: type: string pathwayId: type: array nullable: true items: type: string patientId: type: string patientIsOnCancerPathway: type: boolean presentingComplaint: type: string presentingComplaintIcd10Code: type: string presentingComplaintSnomedCtCode: type: string primaryCareProfessionalId: type: string primaryReferralReason: type: string primaryReferralReasonCode: type: string primaryReferralReasonToVirtualWardCode: type: string priority: type: string priorityCode: type: string priorityLocalCode: type: string referralId: type: string referralLetterContent: type: string referralLetterRid: $ref: "#/components/schemas/Core.MediaReference" referralNotes: type: string referralReceivedTimestamp: type: string format: date-time referralRejectionReason: type: string referralRejectionReasonCode: type: string referralRejectionTimestamp: type: string format: date-time referralSource: type: string referralSourceCode: type: string referralSourceLocalCode: type: string referralType: type: string referrerId: type: string referringOrganisation: type: string referringOrganisationOdsCode: type: string removed: type: boolean removedTimestamp: type: string format: date-time requestedAppointmentType: type: string requestedConsultationMechanism: type: string rttPathwayStatus: type: string rttPeriodEndDate: type: string format: date rttPeriodLength: type: integer rttPeriodStartDate: type: string format: date rvGroupIds: type: array nullable: true items: type: string serviceId: type: string serviceName: type: string serviceType: type: string serviceTypeRequested: type: string serviceTypeRequestedCode: type: string serviceTypeRequestedLocalCode: 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 treatmentFunction: type: string treatmentFunctionCode: type: string treatmentFunctionLocalCode: type: string trustOdsCode: type: string ubrn: type: string wasPatientReferredToDirectAccessService: type: boolean wasReferredByFirstContactPractitioner: type: boolean weeksWaiting: type: integer Patient.ScoredAssessment: type: object properties: admissionId: type: string appointmentId: type: string assessmentToolType: type: string assessmentToolTypeSnomedCtCode: type: string completionTimestamp: type: string format: date-time consultantEpisodeId: type: string patientId: type: string personScore: type: string rvGroupIds: type: array nullable: true items: type: string scoredAssessmentId: type: string uecAttendanceId: type: string virtualWardStayId: type: string Patient.TestResult: type: object properties: attendanceId: type: string expiryDate: type: string format: date-time lastRefreshedAtSourceTimestamp: type: string format: date-time orderingSpecialtyName: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string testDate: type: string format: date-time testId: type: string testName: type: string testOrderedTimestamp: type: string format: date-time testResultId: type: string testValueType: type: string uecAttendanceId: type: string unit: type: string value: type: string valueDouble: type: number format: double Patient.TheatreBooking: 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 lastPoaExpiryDate: type: string format: date lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string mrn: type: string patientId: type: string periOpRiskStratificationOutcome: type: string periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string status: type: string statusRender: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreSessionDate: type: string format: date theatreSessionId: type: string Patient.UecAttendance: type: object properties: acuity: type: string acuitySnomedCtCode: type: string admissionId: type: string ambulanceCallId: type: string ambulanceIncidentId: type: string arrivalMode: type: string arrivalModeSnomedCtCode: type: string arrivalTimestamp: type: string format: date-time attendanceSource: type: string attendanceSourceSite: type: string attendanceSourceSiteOdsCode: type: string attendanceSourceSnomedCtCode: type: string chiefComplaint: type: string chiefComplaintSnomedCtCode: type: string clinicallyReadyToProceedTimestamp: type: string format: date-time consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string conveyingAmbulanceTrust: type: string conveyingAmbulanceTrustOdsCode: type: string decisionToAdmitTimestamp: type: string format: date-time departureTimestamp: type: string format: date-time dischargeDestination: type: string dischargeDestinationSnomedCtCode: type: string dischargeFollowUp: type: string dischargeFollowUpSnomedCtCode: type: string dischargeSite: type: string dischargeSiteOdsCode: type: string dischargeStatus: type: string dischargeStatusSnomedCtCode: type: string edExtendedCareEpisodeId: type: string emergencyCareDepartmentType: type: string emergencyCareDepartmentTypeCode: type: string emergencyCareDepartmentTypeLocalCode: type: string expectedTreatmentAllocationTimestamp: type: string format: date-time expectedTreatmentTimestamp: type: string format: date-time hasDischargeInformationBeenGiven: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string initialAssessmentTimestamp: type: string format: date-time patientId: type: string rvGroupIds: type: array nullable: true items: type: string safeguardingConcerns: type: array nullable: true items: type: string safeguardingConcernsSnomedCtCodes: type: array nullable: true items: type: string seenForTreatmentTimestamp: type: string format: date-time treatmentSite: type: string treatmentSiteOdsCode: type: string uecAttendanceExternalId: type: string uecAttendanceId: type: string urgentAndEmergencyCareAttendanceCategory: type: string urgentAndEmergencyCareAttendanceCategoryCode: type: string urgentAndEmergencyCareAttendanceCategoryLocalCode: type: string Patient.UecReferral: type: object properties: patientId: type: string referralTimestamp: type: string format: date-time referredToService: type: string referredToServiceAssessmentTimestamp: type: string format: date-time referredToServiceSnomedCtCode: type: string rvGroupIds: type: array nullable: true items: type: string uecAttendanceId: type: string uecReferralId: type: string Patient.WardStay: type: object properties: admissionId: type: string endTimestamp: type: string format: date-time patientId: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time wardId: type: string wardStayId: type: string PatientAddressHistory.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string PatientDiagnosis.ConsultantEpisode: type: object properties: admissionId: type: string consultantEpisodeExternalId: type: string consultantEpisodeId: type: string consultantEpisodeSequenceNumber: type: integer endTimestamp: type: string format: date-time healthcareProvider: type: string healthcareProviderOdsCode: type: string patientId: type: string psychiatricPatientStatus: type: string psychiatricPatientStatusCode: type: string psychiatricPatientStatusLocalCode: type: string rehabilitationAssessmentTeamType: type: string rehabilitationAssessmentTeamTypeCode: type: string rehabilitationAssessmentTeamTypeLocalCode: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time totalNumberOfRehabilitationDays: type: integer totalNumberOfSpecialistPalliativeCareDays: type: integer treatmentFunction: type: string treatmentFunctionCode: type: string PatientDiagnosis.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string PatientDiagnosis.UecAttendance: type: object properties: acuity: type: string acuitySnomedCtCode: type: string admissionId: type: string ambulanceCallId: type: string ambulanceIncidentId: type: string arrivalMode: type: string arrivalModeSnomedCtCode: type: string arrivalTimestamp: type: string format: date-time attendanceSource: type: string attendanceSourceSite: type: string attendanceSourceSiteOdsCode: type: string attendanceSourceSnomedCtCode: type: string chiefComplaint: type: string chiefComplaintSnomedCtCode: type: string clinicallyReadyToProceedTimestamp: type: string format: date-time consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string conveyingAmbulanceTrust: type: string conveyingAmbulanceTrustOdsCode: type: string decisionToAdmitTimestamp: type: string format: date-time departureTimestamp: type: string format: date-time dischargeDestination: type: string dischargeDestinationSnomedCtCode: type: string dischargeFollowUp: type: string dischargeFollowUpSnomedCtCode: type: string dischargeSite: type: string dischargeSiteOdsCode: type: string dischargeStatus: type: string dischargeStatusSnomedCtCode: type: string edExtendedCareEpisodeId: type: string emergencyCareDepartmentType: type: string emergencyCareDepartmentTypeCode: type: string emergencyCareDepartmentTypeLocalCode: type: string expectedTreatmentAllocationTimestamp: type: string format: date-time expectedTreatmentTimestamp: type: string format: date-time hasDischargeInformationBeenGiven: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string initialAssessmentTimestamp: type: string format: date-time patientId: type: string rvGroupIds: type: array nullable: true items: type: string safeguardingConcerns: type: array nullable: true items: type: string safeguardingConcernsSnomedCtCodes: type: array nullable: true items: type: string seenForTreatmentTimestamp: type: string format: date-time treatmentSite: type: string treatmentSiteOdsCode: type: string uecAttendanceExternalId: type: string uecAttendanceId: type: string urgentAndEmergencyCareAttendanceCategory: type: string urgentAndEmergencyCareAttendanceCategoryCode: type: string urgentAndEmergencyCareAttendanceCategoryLocalCode: type: string PatientDiagnosis.VirtualWardStay: type: object properties: activityLocationType: type: string activityLocationTypeCode: type: string admissionSource: type: string admissionSourceCode: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string endTimestamp: type: string format: date-time expectedCommissioner: type: string expectedCommissionerOdsCode: type: string isPatientSubjectToRemoteMonitoring: type: boolean methodOfDischarge: type: string methodOfDischargeCode: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time trustOdsCode: type: string virtualWardId: type: string virtualWardStayId: type: string PatientPathway.CareProfessional: type: object properties: careProfessionalId: type: string careProfessionalLocalId: type: string isActive: type: boolean localSubSpecialties: type: array nullable: true items: type: string mainSpecialty: type: string mainSpecialtyCode: type: string name: type: string professionalRegistrationBody: type: string professionalRegistrationBodyCode: type: string professionalRegistrationEntryId: type: string role: type: string rvGroupIds: type: array nullable: true items: type: string PatientPathway.CdmPathwayComment: type: object properties: commentStatus: type: string commentText: type: string commentType: type: string createdAt: type: string format: date-time createdBy: type: string pathwayCommentId: type: string pathwayId: type: string source: type: string updatedAt: type: string format: date-time updatedBy: type: string PatientPathway.DiagnosticsWaitlistEntry: 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 nullable: true items: type: string sixWeekBreachDate: type: string format: date specialtyId: type: string PatientPathway.Encounter: type: object properties: administrativeCategoryCode: type: string administrativeCategoryDescription: type: string admissionMethod: type: string admissionOfferTimestamp: type: string format: date-time admissionStatus: type: string admissionSubStatus: type: string admissionType: type: string atsTotalTheatreTime: type: integer calculatedTotalTheatreTime: type: integer cancerPriorityOrdering: type: integer createdBy: type: string createdDate: type: string format: date criticalCareBedStatus: type: string division: type: string ealId: type: string encounterFreeText: type: string encounterId: type: string encounterType: type: string estimatedTotalTheatreTime: type: integer externalId: type: string genericWaitlistEntryId: type: string hasDateInTheLastNDays: type: boolean 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 isAdmissionOfferTimestampInTheLastNDays: type: boolean isBooked: type: boolean isMetricEncounter: type: boolean isSuitableForPooledList: type: boolean isSurgicalOrderDateInTheLastNDays: type: boolean isTciDateInTheLastNDays: type: boolean issues: type: array nullable: true items: type: string lastCovidSwabBookingStatus: type: string lastCovidSwabOutcome: type: string lastMrsaSwabBookingStatus: type: string lastMrsaSwabOutcome: type: string lastPoaBookingStatus: type: string lastPoaExpiryDate: type: string format: date lastPoaOutcome: type: string lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string lastPoaScheduledOrAttendedDatetime: type: string format: date-time lastRefreshedAtSourceTimestamp: 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 periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string site: type: string siteId: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string surgicalOrderDate: type: string format: date 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 PatientPathway.OutpatientActivity: 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 genericWaitlistEntryId: type: string isPrivate: type: boolean isReferral: type: boolean issues: type: array nullable: true 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 nullable: true 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 PatientPathway.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string PatientPathway.Referral: 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 isReferralToVirtualWard: type: boolean mrn: type: string pathwayId: type: array nullable: true items: type: string patientId: type: string patientIsOnCancerPathway: type: boolean presentingComplaint: type: string presentingComplaintIcd10Code: type: string presentingComplaintSnomedCtCode: type: string primaryCareProfessionalId: type: string primaryReferralReason: type: string primaryReferralReasonCode: type: string primaryReferralReasonToVirtualWardCode: type: string priority: type: string priorityCode: type: string priorityLocalCode: type: string referralId: type: string referralLetterContent: type: string referralLetterRid: $ref: "#/components/schemas/Core.MediaReference" referralNotes: type: string referralReceivedTimestamp: type: string format: date-time referralRejectionReason: type: string referralRejectionReasonCode: type: string referralRejectionTimestamp: type: string format: date-time referralSource: type: string referralSourceCode: type: string referralSourceLocalCode: type: string referralType: type: string referrerId: type: string referringOrganisation: type: string referringOrganisationOdsCode: type: string removed: type: boolean removedTimestamp: type: string format: date-time requestedAppointmentType: type: string requestedConsultationMechanism: type: string rttPathwayStatus: type: string rttPeriodEndDate: type: string format: date rttPeriodLength: type: integer rttPeriodStartDate: type: string format: date rvGroupIds: type: array nullable: true items: type: string serviceId: type: string serviceName: type: string serviceType: type: string serviceTypeRequested: type: string serviceTypeRequestedCode: type: string serviceTypeRequestedLocalCode: 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 treatmentFunction: type: string treatmentFunctionCode: type: string treatmentFunctionLocalCode: type: string trustOdsCode: type: string ubrn: type: string wasPatientReferredToDirectAccessService: type: boolean wasReferredByFirstContactPractitioner: type: boolean weeksWaiting: type: integer PatientPathway.Site: type: object properties: id: type: string name: type: string rvGroupIds: type: array nullable: true items: type: string siteOdsCode: type: string PatientPathway.Specialty: type: object properties: isActiveSpecialty: type: boolean rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string theatreSpecialty: type: boolean Pregnancy.Birth: type: object properties: admissionId: type: string babyPatientId: type: string birthId: type: string birthSequenceNumber: type: integer birthWeightGrams: type: integer deliveryMethod: type: string deliveryMethodCode: type: string deliveryMethodLocalCode: type: string gestationLengthWeeks: type: integer isStillBirth: type: boolean labourId: type: string liveOrStillBirth: type: string liveOrStillBirthCode: type: string liveOrStillBirthLocalCode: type: string pregnancyId: type: string resuscitationMethod: type: string resuscitationMethodCode: type: string resuscitationMethodLocalCode: type: string rvGroupIds: type: array nullable: true items: type: string statusOfPersonConductingDelivery: type: string statusOfPersonConductingDeliveryCode: type: string statusOfPersonConductingDeliveryLocalCode: type: string Pregnancy.CareProfessional: type: object properties: careProfessionalId: type: string careProfessionalLocalId: type: string isActive: type: boolean localSubSpecialties: type: array nullable: true items: type: string mainSpecialty: type: string mainSpecialtyCode: type: string name: type: string professionalRegistrationBody: type: string professionalRegistrationBodyCode: type: string professionalRegistrationEntryId: type: string role: type: string rvGroupIds: type: array nullable: true items: type: string Pregnancy.Labour: type: object properties: actualDeliveryPlace: type: string actualDeliveryPlaceCode: type: string actualDeliveryPlaceLocalCode: type: string admissionId: type: string anaestheticGivenDuringLabourOrDelivery: type: string anaestheticGivenDuringLabourOrDeliveryCode: type: string anaestheticGivenDuringLabourOrDeliveryLocalCode: type: string anaestheticGivenPostLabourOrDelivery: type: string anaestheticGivenPostLabourOrDeliveryCode: type: string anaestheticGivenPostLabourOrDeliveryLocalCode: type: string consultantEpisodeId: type: string deliveryPlaceChangeReason: type: string deliveryPlaceChangeReasonCode: type: string deliveryPlaceChangeReasonLocalCode: type: string labourId: type: string labourOrDeliveryOnsetMethod: type: string labourOrDeliveryOnsetMethodCode: type: string labourOrDeliveryOnsetMethodLocalCode: type: string pregnancyId: type: string rvGroupIds: type: array nullable: true items: type: string Pregnancy.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Procedure.CareProfessional: type: object properties: careProfessionalId: type: string careProfessionalLocalId: type: string isActive: type: boolean localSubSpecialties: type: array nullable: true items: type: string mainSpecialty: type: string mainSpecialtyCode: type: string name: type: string professionalRegistrationBody: type: string professionalRegistrationBodyCode: type: string professionalRegistrationEntryId: type: string role: type: string rvGroupIds: type: array nullable: true items: type: string Procedure.ConsultantEpisode: type: object properties: admissionId: type: string consultantEpisodeExternalId: type: string consultantEpisodeId: type: string consultantEpisodeSequenceNumber: type: integer endTimestamp: type: string format: date-time healthcareProvider: type: string healthcareProviderOdsCode: type: string patientId: type: string psychiatricPatientStatus: type: string psychiatricPatientStatusCode: type: string psychiatricPatientStatusLocalCode: type: string rehabilitationAssessmentTeamType: type: string rehabilitationAssessmentTeamTypeCode: type: string rehabilitationAssessmentTeamTypeLocalCode: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time totalNumberOfRehabilitationDays: type: integer totalNumberOfSpecialistPalliativeCareDays: type: integer treatmentFunction: type: string treatmentFunctionCode: type: string Procedure.Encounter: type: object properties: administrativeCategoryCode: type: string administrativeCategoryDescription: type: string admissionMethod: type: string admissionOfferTimestamp: type: string format: date-time admissionStatus: type: string admissionSubStatus: type: string admissionType: type: string atsTotalTheatreTime: type: integer calculatedTotalTheatreTime: type: integer cancerPriorityOrdering: type: integer createdBy: type: string createdDate: type: string format: date criticalCareBedStatus: type: string division: type: string ealId: type: string encounterFreeText: type: string encounterId: type: string encounterType: type: string estimatedTotalTheatreTime: type: integer externalId: type: string genericWaitlistEntryId: type: string hasDateInTheLastNDays: type: boolean 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 isAdmissionOfferTimestampInTheLastNDays: type: boolean isBooked: type: boolean isMetricEncounter: type: boolean isSuitableForPooledList: type: boolean isSurgicalOrderDateInTheLastNDays: type: boolean isTciDateInTheLastNDays: type: boolean issues: type: array nullable: true items: type: string lastCovidSwabBookingStatus: type: string lastCovidSwabOutcome: type: string lastMrsaSwabBookingStatus: type: string lastMrsaSwabOutcome: type: string lastPoaBookingStatus: type: string lastPoaExpiryDate: type: string format: date lastPoaOutcome: type: string lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string lastPoaScheduledOrAttendedDatetime: type: string format: date-time lastRefreshedAtSourceTimestamp: 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 periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string site: type: string siteId: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string surgicalOrderDate: type: string format: date 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 Procedure.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Procedure.ProcedureStatus: 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 poaExpiryDate: type: string format: date poaOrdering: type: integer poaOutcome: type: string poaOutcomeDate: type: string format: date poaOutcomeFreeText: type: string poaScheduledOrAttendedDatetime: type: string format: date-time procedureId: type: string procedureStatusId: type: string rvGroupIds: type: array nullable: true items: type: string theatreBookingId: type: string Procedure.TheatreBooking: 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 lastPoaExpiryDate: type: string format: date lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string mrn: type: string patientId: type: string periOpRiskStratificationOutcome: type: string periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string status: type: string statusRender: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreSessionDate: type: string format: date theatreSessionId: type: string Procedure.TheatreSession: 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 anaestheticTypes: type: array nullable: true items: type: string anaesthetistIds: type: array nullable: true items: type: string anaesthetistNames: type: array nullable: true items: type: string anaesthetistRequired: type: boolean bookedMinutes: type: integer bookedUtilisation: type: number format: double bookedUtilisationStatus: type: string bookingCancellationsOnTheDayCount: type: integer bookingCancellationsTotalCount: type: integer cancellationReason: type: string cancelled: type: boolean comments: type: array nullable: true items: type: string consultantIds: type: array nullable: true items: type: string consultantLeaveStatus: type: string consultantNames: type: array nullable: true 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 plannedSessionMinutes: type: integer plannedSessionUtilisation: type: number format: double plannedStartTime: type: string format: date-time pooledList: type: boolean primaryAnaesthetistId: type: string primaryAnaesthetistName: type: string primaryConsultantId: type: string primaryConsultantName: type: string rvGroupIds: type: array nullable: true 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 Procedure.UecAttendance: type: object properties: acuity: type: string acuitySnomedCtCode: type: string admissionId: type: string ambulanceCallId: type: string ambulanceIncidentId: type: string arrivalMode: type: string arrivalModeSnomedCtCode: type: string arrivalTimestamp: type: string format: date-time attendanceSource: type: string attendanceSourceSite: type: string attendanceSourceSiteOdsCode: type: string attendanceSourceSnomedCtCode: type: string chiefComplaint: type: string chiefComplaintSnomedCtCode: type: string clinicallyReadyToProceedTimestamp: type: string format: date-time consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string conveyingAmbulanceTrust: type: string conveyingAmbulanceTrustOdsCode: type: string decisionToAdmitTimestamp: type: string format: date-time departureTimestamp: type: string format: date-time dischargeDestination: type: string dischargeDestinationSnomedCtCode: type: string dischargeFollowUp: type: string dischargeFollowUpSnomedCtCode: type: string dischargeSite: type: string dischargeSiteOdsCode: type: string dischargeStatus: type: string dischargeStatusSnomedCtCode: type: string edExtendedCareEpisodeId: type: string emergencyCareDepartmentType: type: string emergencyCareDepartmentTypeCode: type: string emergencyCareDepartmentTypeLocalCode: type: string expectedTreatmentAllocationTimestamp: type: string format: date-time expectedTreatmentTimestamp: type: string format: date-time hasDischargeInformationBeenGiven: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string initialAssessmentTimestamp: type: string format: date-time patientId: type: string rvGroupIds: type: array nullable: true items: type: string safeguardingConcerns: type: array nullable: true items: type: string safeguardingConcernsSnomedCtCodes: type: array nullable: true items: type: string seenForTreatmentTimestamp: type: string format: date-time treatmentSite: type: string treatmentSiteOdsCode: type: string uecAttendanceExternalId: type: string uecAttendanceId: type: string urgentAndEmergencyCareAttendanceCategory: type: string urgentAndEmergencyCareAttendanceCategoryCode: type: string urgentAndEmergencyCareAttendanceCategoryLocalCode: type: string Procedure.VirtualWardStay: type: object properties: activityLocationType: type: string activityLocationTypeCode: type: string admissionSource: type: string admissionSourceCode: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string endTimestamp: type: string format: date-time expectedCommissioner: type: string expectedCommissionerOdsCode: type: string isPatientSubjectToRemoteMonitoring: type: boolean methodOfDischarge: type: string methodOfDischargeCode: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time trustOdsCode: type: string virtualWardId: type: string virtualWardStayId: type: string ProcedureStatus.Encounter: type: object properties: administrativeCategoryCode: type: string administrativeCategoryDescription: type: string admissionMethod: type: string admissionOfferTimestamp: type: string format: date-time admissionStatus: type: string admissionSubStatus: type: string admissionType: type: string atsTotalTheatreTime: type: integer calculatedTotalTheatreTime: type: integer cancerPriorityOrdering: type: integer createdBy: type: string createdDate: type: string format: date criticalCareBedStatus: type: string division: type: string ealId: type: string encounterFreeText: type: string encounterId: type: string encounterType: type: string estimatedTotalTheatreTime: type: integer externalId: type: string genericWaitlistEntryId: type: string hasDateInTheLastNDays: type: boolean 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 isAdmissionOfferTimestampInTheLastNDays: type: boolean isBooked: type: boolean isMetricEncounter: type: boolean isSuitableForPooledList: type: boolean isSurgicalOrderDateInTheLastNDays: type: boolean isTciDateInTheLastNDays: type: boolean issues: type: array nullable: true items: type: string lastCovidSwabBookingStatus: type: string lastCovidSwabOutcome: type: string lastMrsaSwabBookingStatus: type: string lastMrsaSwabOutcome: type: string lastPoaBookingStatus: type: string lastPoaExpiryDate: type: string format: date lastPoaOutcome: type: string lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string lastPoaScheduledOrAttendedDatetime: type: string format: date-time lastRefreshedAtSourceTimestamp: 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 periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string site: type: string siteId: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string surgicalOrderDate: type: string format: date 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 ProcedureStatus.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string ProcedureStatus.Procedure: type: object properties: actualProcedureTimeKnifeToSkinClosure: type: integer actualProcedureTimeTotalTheatreTime: type: integer admissionId: type: string admissionMethodDescription: type: string anaestheticTypeToBeUsed: type: string anaesthetistRequired: type: boolean appointmentId: type: string consultantEpisodeId: type: string 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 procedure: type: string procedureDate: type: string format: date procedureId: type: string procedureOpcsCode: type: string procedureOrdered: type: integer procedureSnomedCtCode: type: string procedureTimeOrOrder: type: string procedureTimestamp: type: string format: date-time responsibleAnaesthetistCareProfessionalId: type: string rvGroupIds: type: array nullable: true items: type: string theatreSessionId: type: string title: type: string uecAttendanceId: type: string virtualWardStayId: type: string ProcedureStatus.TheatreBooking: 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 lastPoaExpiryDate: type: string format: date lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string mrn: type: string patientId: type: string periOpRiskStratificationOutcome: type: string periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string status: type: string statusRender: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreSessionDate: type: string format: date theatreSessionId: type: string RadiologyExam.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Referral.Appointment: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string appointmentBookedReason: type: string appointmentBookedReasonCode: type: string appointmentBookedReasonLocalCode: type: string appointmentFreeText: type: string attendanceId: type: string attendanceStatus: type: string attendanceStatusCode: type: string attendanceStatusLocalCode: type: string bookedBy: type: string bookedDuration: type: integer bookingStatus: type: string cancellationReason: type: string cancelledBy: type: string cancerPriorityOrdering: type: integer category: type: string clinicId: type: string code: type: string consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string dateTimeBooked: type: string format: date-time dateTimeCancelled: type: string format: date-time earliestClinicallyAppropriateDate: type: string format: date earliestReasonableOfferDate: type: string format: date endDateTime: type: string format: date-time hasDateInTheLastNDays: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string isDateTimeBookedInTheLastNDays: type: boolean isDateTimeCancelledInTheLastNDays: type: boolean isFirstAppointment: type: boolean isOrderedDateInTheLastNDays: type: boolean isPoaAppointment: type: boolean isStartDateTimeInTheLastNDays: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time latestClinicallyAppropriateDate: type: string format: date orderedDate: type: string format: date outcomeOfAttendance: type: string outcomeOfAttendanceCode: type: string outcomeOfAttendanceLocalCode: type: string pathwayId: type: string 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 nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string startDateTime: type: string format: date-time treatmentFunctionCode: type: string treatmentFunctionLocalCode: type: string treatmentFunctionName: type: string type: type: string wasPatientOnPifuPathway: type: boolean wasPatientSubjectToRemoteMontitoring: type: boolean Referral.ErsService: type: object properties: active: type: boolean referralReason: type: string rvGroupIds: type: array nullable: true items: type: string serviceDirectoryId: type: string serviceName: type: string serviceType: type: string siteId: type: string specialtyIds: type: array nullable: true items: type: string uniqueId: type: string Referral.OutpatientActivity: 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 genericWaitlistEntryId: type: string isPrivate: type: boolean isReferral: type: boolean issues: type: array nullable: true 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 nullable: true 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 Referral.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string Referral.PatientPathway: type: object properties: _104WeeksBreachDate: type: string format: date _18WeeksBreachDate: type: string format: date _52WeeksBreachDate: type: string format: date _65WeeksBreachDate: type: string format: date _78WeeksBreachDate: type: string format: date accessibilityFlags: type: array nullable: true items: type: string admissionMethodCode: type: string age: type: string format: long closureReason: type: string consultantId: type: string consultantName: type: string covidPriority: type: string covidPriorityDate: type: string format: date dataSource: type: string dateOfBirth: type: string format: date daysTo104WeekBreachDate: type: integer daysTo18WeekBreachDate: type: integer daysTo52WeekBreachDate: type: integer daysTo65WeekBreachDate: type: integer daysTo78WeekBreachDate: type: integer derivedPathwayType: type: string directorate: type: string division: type: string dtaDate: type: string format: date intendedProcedureDescription: type: string isActiveRttPathway: type: boolean isOpenPathway: type: boolean 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 latestEpisodeId: type: string latestPathwayStatusCodeNational: type: string latestPathwayStatusDescriptionNational: type: string latestPeriodEndDate: type: string format: date latestPeriodEndReason: type: string latestPeriodLengthDays: type: integer latestPeriodLengthWeeks: type: integer latestPeriodStartDate: type: string format: date latestPeriodStartReason: type: string latestProcedurePriorityCode: type: string latestReferralReceivedDate: type: string format: date latestRttPeriodId: type: string 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 originalReferralSpecialtyId: type: string originalReferralSpecialtyName: type: string owlClinicCode: type: string owlFlag: type: boolean owlGroupCode: type: string pathwayClass: type: string pathwayEndDate: type: string format: date pathwayId: type: string pathwayStage: type: string pathwayStartDate: type: string format: date pathwayStatus: type: string pathwaySubtype: type: string pathwayType: type: string patientDeceased: type: boolean patientId: type: string patientName: type: string ppid: type: string ppidIssuer: type: string ppidIssuerOdsCode: type: string prospectiveRttPeriodEndDate: type: string format: date prospectiveRttWeeksWait: type: integer referralDate: type: string format: date referralId: type: string referralPriority: type: string referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true 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 waitingTimeMeasurementType: type: string waitingTimeMeasurementTypeCode: type: string waitingTimeMeasurementTypeCodeLocalCode: type: string weeksTo104WeekBreachDate: type: integer weeksTo18WeekBreachDate: type: integer weeksTo52WeekBreachDate: type: integer weeksTo65WeekBreachDate: type: integer weeksTo78WeekBreachDate: type: integer weeksWaitSinceDtaDate: type: integer weeksWaitSinceLastPatientContact: type: integer weeksWaitToProspectiveRttPeriodEndDate: type: integer weeksWaitToTciDate: type: integer ScoredAssessment.Admission: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string admissionExternalId: type: string admissionId: type: string admissionMethod: type: string admissionSource: type: string admissionSourceCode: type: string admissionSourceLocalCode: type: string admissionStatus: type: string admissionTimestamp: type: string format: date-time admissionTitle: type: string admissionType: type: string bedLocation: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string destinationOfDischargeLocalCode: type: string dischargeDestinationType: type: string dischargePathway: type: string dischargeReadyDate: type: string format: date dischargeTimestamp: type: string format: date-time ealEntryId: type: string encounterId: type: string estimatedDischargeDate: type: string format: date-time isDischargeTimeConfirmed: type: boolean localAuthority: type: string methodOfAdmission: type: string methodOfAdmissionCode: type: string methodOfAdmissionLocalCode: type: string methodOfDischarge: type: string methodOfDischargeCode: type: string methodOfDischargeLocalCode: type: string pathwayId: type: string patientClassification: type: string patientClassificationCode: type: string patientClassificationLocalCode: type: string patientId: type: string patientName: type: string rvGroupIds: type: array nullable: true items: type: string siteName: type: string specialtyId: type: string specialtyName: type: string startTimestamp: type: string format: date-time treatmentFunctionCode: type: string ward: type: string wasPatientDischargedToNhsAtHomeService: type: boolean ScoredAssessment.Appointment: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string appointmentBookedReason: type: string appointmentBookedReasonCode: type: string appointmentBookedReasonLocalCode: type: string appointmentFreeText: type: string attendanceId: type: string attendanceStatus: type: string attendanceStatusCode: type: string attendanceStatusLocalCode: type: string bookedBy: type: string bookedDuration: type: integer bookingStatus: type: string cancellationReason: type: string cancelledBy: type: string cancerPriorityOrdering: type: integer category: type: string clinicId: type: string code: type: string consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string dateTimeBooked: type: string format: date-time dateTimeCancelled: type: string format: date-time earliestClinicallyAppropriateDate: type: string format: date earliestReasonableOfferDate: type: string format: date endDateTime: type: string format: date-time hasDateInTheLastNDays: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string isDateTimeBookedInTheLastNDays: type: boolean isDateTimeCancelledInTheLastNDays: type: boolean isFirstAppointment: type: boolean isOrderedDateInTheLastNDays: type: boolean isPoaAppointment: type: boolean isStartDateTimeInTheLastNDays: type: boolean lastRefreshedAtSourceTimestamp: type: string format: date-time latestClinicallyAppropriateDate: type: string format: date orderedDate: type: string format: date outcomeOfAttendance: type: string outcomeOfAttendanceCode: type: string outcomeOfAttendanceLocalCode: type: string pathwayId: type: string 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 nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string startDateTime: type: string format: date-time treatmentFunctionCode: type: string treatmentFunctionLocalCode: type: string treatmentFunctionName: type: string type: type: string wasPatientOnPifuPathway: type: boolean wasPatientSubjectToRemoteMontitoring: type: boolean ScoredAssessment.ConsultantEpisode: type: object properties: admissionId: type: string consultantEpisodeExternalId: type: string consultantEpisodeId: type: string consultantEpisodeSequenceNumber: type: integer endTimestamp: type: string format: date-time healthcareProvider: type: string healthcareProviderOdsCode: type: string patientId: type: string psychiatricPatientStatus: type: string psychiatricPatientStatusCode: type: string psychiatricPatientStatusLocalCode: type: string rehabilitationAssessmentTeamType: type: string rehabilitationAssessmentTeamTypeCode: type: string rehabilitationAssessmentTeamTypeLocalCode: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time totalNumberOfRehabilitationDays: type: integer totalNumberOfSpecialistPalliativeCareDays: type: integer treatmentFunction: type: string treatmentFunctionCode: type: string ScoredAssessment.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string ScoredAssessment.UecAttendance: type: object properties: acuity: type: string acuitySnomedCtCode: type: string admissionId: type: string ambulanceCallId: type: string ambulanceIncidentId: type: string arrivalMode: type: string arrivalModeSnomedCtCode: type: string arrivalTimestamp: type: string format: date-time attendanceSource: type: string attendanceSourceSite: type: string attendanceSourceSiteOdsCode: type: string attendanceSourceSnomedCtCode: type: string chiefComplaint: type: string chiefComplaintSnomedCtCode: type: string clinicallyReadyToProceedTimestamp: type: string format: date-time consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string conveyingAmbulanceTrust: type: string conveyingAmbulanceTrustOdsCode: type: string decisionToAdmitTimestamp: type: string format: date-time departureTimestamp: type: string format: date-time dischargeDestination: type: string dischargeDestinationSnomedCtCode: type: string dischargeFollowUp: type: string dischargeFollowUpSnomedCtCode: type: string dischargeSite: type: string dischargeSiteOdsCode: type: string dischargeStatus: type: string dischargeStatusSnomedCtCode: type: string edExtendedCareEpisodeId: type: string emergencyCareDepartmentType: type: string emergencyCareDepartmentTypeCode: type: string emergencyCareDepartmentTypeLocalCode: type: string expectedTreatmentAllocationTimestamp: type: string format: date-time expectedTreatmentTimestamp: type: string format: date-time hasDischargeInformationBeenGiven: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string initialAssessmentTimestamp: type: string format: date-time patientId: type: string rvGroupIds: type: array nullable: true items: type: string safeguardingConcerns: type: array nullable: true items: type: string safeguardingConcernsSnomedCtCodes: type: array nullable: true items: type: string seenForTreatmentTimestamp: type: string format: date-time treatmentSite: type: string treatmentSiteOdsCode: type: string uecAttendanceExternalId: type: string uecAttendanceId: type: string urgentAndEmergencyCareAttendanceCategory: type: string urgentAndEmergencyCareAttendanceCategoryCode: type: string urgentAndEmergencyCareAttendanceCategoryLocalCode: type: string ScoredAssessment.VirtualWardStay: type: object properties: activityLocationType: type: string activityLocationTypeCode: type: string admissionSource: type: string admissionSourceCode: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string endTimestamp: type: string format: date-time expectedCommissioner: type: string expectedCommissionerOdsCode: type: string isPatientSubjectToRemoteMonitoring: type: boolean methodOfDischarge: type: string methodOfDischargeCode: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time trustOdsCode: type: string virtualWardId: type: string virtualWardStayId: type: string Site.CdmTeam: type: object properties: cancerSites: type: array nullable: true items: type: string careServiceId: type: string createdAt: type: string format: date-time createdBy: type: string description: type: string locationIds: type: array nullable: true items: type: string modules: type: array nullable: true items: type: string name: type: string siteIds: type: array nullable: true items: type: string siteNames: type: array nullable: true items: type: string specialties: type: array nullable: true items: type: string status: type: string teamId: type: string teamTypes: type: array nullable: true items: type: string updatedAt: type: string format: date-time updatedBy: type: string Site.ErsService: type: object properties: active: type: boolean referralReason: type: string rvGroupIds: type: array nullable: true items: type: string serviceDirectoryId: type: string serviceName: type: string serviceType: type: string siteId: type: string specialtyIds: type: array nullable: true items: type: string uniqueId: type: string Site.PatientPathway: type: object properties: _104WeeksBreachDate: type: string format: date _18WeeksBreachDate: type: string format: date _52WeeksBreachDate: type: string format: date _65WeeksBreachDate: type: string format: date _78WeeksBreachDate: type: string format: date accessibilityFlags: type: array nullable: true items: type: string admissionMethodCode: type: string age: type: string format: long closureReason: type: string consultantId: type: string consultantName: type: string covidPriority: type: string covidPriorityDate: type: string format: date dataSource: type: string dateOfBirth: type: string format: date daysTo104WeekBreachDate: type: integer daysTo18WeekBreachDate: type: integer daysTo52WeekBreachDate: type: integer daysTo65WeekBreachDate: type: integer daysTo78WeekBreachDate: type: integer derivedPathwayType: type: string directorate: type: string division: type: string dtaDate: type: string format: date intendedProcedureDescription: type: string isActiveRttPathway: type: boolean isOpenPathway: type: boolean 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 latestEpisodeId: type: string latestPathwayStatusCodeNational: type: string latestPathwayStatusDescriptionNational: type: string latestPeriodEndDate: type: string format: date latestPeriodEndReason: type: string latestPeriodLengthDays: type: integer latestPeriodLengthWeeks: type: integer latestPeriodStartDate: type: string format: date latestPeriodStartReason: type: string latestProcedurePriorityCode: type: string latestReferralReceivedDate: type: string format: date latestRttPeriodId: type: string 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 originalReferralSpecialtyId: type: string originalReferralSpecialtyName: type: string owlClinicCode: type: string owlFlag: type: boolean owlGroupCode: type: string pathwayClass: type: string pathwayEndDate: type: string format: date pathwayId: type: string pathwayStage: type: string pathwayStartDate: type: string format: date pathwayStatus: type: string pathwaySubtype: type: string pathwayType: type: string patientDeceased: type: boolean patientId: type: string patientName: type: string ppid: type: string ppidIssuer: type: string ppidIssuerOdsCode: type: string prospectiveRttPeriodEndDate: type: string format: date prospectiveRttWeeksWait: type: integer referralDate: type: string format: date referralId: type: string referralPriority: type: string referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true 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 waitingTimeMeasurementType: type: string waitingTimeMeasurementTypeCode: type: string waitingTimeMeasurementTypeCodeLocalCode: type: string weeksTo104WeekBreachDate: type: integer weeksTo18WeekBreachDate: type: integer weeksTo52WeekBreachDate: type: integer weeksTo65WeekBreachDate: type: integer weeksTo78WeekBreachDate: type: integer weeksWaitSinceDtaDate: type: integer weeksWaitSinceLastPatientContact: type: integer weeksWaitToProspectiveRttPeriodEndDate: type: integer weeksWaitToTciDate: type: integer Specialty.BookingRequest: type: object properties: action: type: string amPm: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserGroup: type: string assignedUserIds: type: array nullable: true items: type: string bookingRequestId: type: string closedAt: type: string format: date-time closedBy: type: string comment: type: string consultantId: type: string date: type: string format: date encounterEstimatedTotalTheatreTime: type: integer encounterId: type: string intendedPrimaryProcedureDescription: type: string intendedPrimaryProcedureFreeText: type: string mnemonic: type: string mrn: type: string personId: type: string reason: type: string specialtyId: type: string status: type: string taskDueDate: type: string format: date taskPriority: type: string taskType: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreName: type: string theatreSessionId: type: string theatreSessionPlannedDurationMinutes: type: integer theatreSessionPrimaryConsultantId: type: string timestamp: type: string format: date-time title: type: string type: type: string updatedAt: type: string format: date-time updatedBy: type: string userId: type: string Specialty.CdmTeam: type: object properties: cancerSites: type: array nullable: true items: type: string careServiceId: type: string createdAt: type: string format: date-time createdBy: type: string description: type: string locationIds: type: array nullable: true items: type: string modules: type: array nullable: true items: type: string name: type: string siteIds: type: array nullable: true items: type: string siteNames: type: array nullable: true items: type: string specialties: type: array nullable: true items: type: string status: type: string teamId: type: string teamTypes: type: array nullable: true items: type: string updatedAt: type: string format: date-time updatedBy: type: string Specialty.ClinicType: type: object properties: clinicTypeActive: type: boolean clinicTypeId: type: string clinicTypeName: type: string rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string Specialty.DiagnosticsWaitlistEntry: 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 nullable: true items: type: string sixWeekBreachDate: type: string format: date specialtyId: type: string Specialty.Encounter: type: object properties: administrativeCategoryCode: type: string administrativeCategoryDescription: type: string admissionMethod: type: string admissionOfferTimestamp: type: string format: date-time admissionStatus: type: string admissionSubStatus: type: string admissionType: type: string atsTotalTheatreTime: type: integer calculatedTotalTheatreTime: type: integer cancerPriorityOrdering: type: integer createdBy: type: string createdDate: type: string format: date criticalCareBedStatus: type: string division: type: string ealId: type: string encounterFreeText: type: string encounterId: type: string encounterType: type: string estimatedTotalTheatreTime: type: integer externalId: type: string genericWaitlistEntryId: type: string hasDateInTheLastNDays: type: boolean 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 isAdmissionOfferTimestampInTheLastNDays: type: boolean isBooked: type: boolean isMetricEncounter: type: boolean isSuitableForPooledList: type: boolean isSurgicalOrderDateInTheLastNDays: type: boolean isTciDateInTheLastNDays: type: boolean issues: type: array nullable: true items: type: string lastCovidSwabBookingStatus: type: string lastCovidSwabOutcome: type: string lastMrsaSwabBookingStatus: type: string lastMrsaSwabOutcome: type: string lastPoaBookingStatus: type: string lastPoaExpiryDate: type: string format: date lastPoaOutcome: type: string lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string lastPoaScheduledOrAttendedDatetime: type: string format: date-time lastRefreshedAtSourceTimestamp: 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 periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string site: type: string siteId: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string surgicalOrderDate: type: string format: date 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 Specialty.ErsService: type: object properties: active: type: boolean referralReason: type: string rvGroupIds: type: array nullable: true items: type: string serviceDirectoryId: type: string serviceName: type: string serviceType: type: string siteId: type: string specialtyIds: type: array nullable: true items: type: string uniqueId: type: string Specialty.OutpatientActivity: 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 genericWaitlistEntryId: type: string isPrivate: type: boolean isReferral: type: boolean issues: type: array nullable: true 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 nullable: true 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 Specialty.PatientPathway: type: object properties: _104WeeksBreachDate: type: string format: date _18WeeksBreachDate: type: string format: date _52WeeksBreachDate: type: string format: date _65WeeksBreachDate: type: string format: date _78WeeksBreachDate: type: string format: date accessibilityFlags: type: array nullable: true items: type: string admissionMethodCode: type: string age: type: string format: long closureReason: type: string consultantId: type: string consultantName: type: string covidPriority: type: string covidPriorityDate: type: string format: date dataSource: type: string dateOfBirth: type: string format: date daysTo104WeekBreachDate: type: integer daysTo18WeekBreachDate: type: integer daysTo52WeekBreachDate: type: integer daysTo65WeekBreachDate: type: integer daysTo78WeekBreachDate: type: integer derivedPathwayType: type: string directorate: type: string division: type: string dtaDate: type: string format: date intendedProcedureDescription: type: string isActiveRttPathway: type: boolean isOpenPathway: type: boolean 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 latestEpisodeId: type: string latestPathwayStatusCodeNational: type: string latestPathwayStatusDescriptionNational: type: string latestPeriodEndDate: type: string format: date latestPeriodEndReason: type: string latestPeriodLengthDays: type: integer latestPeriodLengthWeeks: type: integer latestPeriodStartDate: type: string format: date latestPeriodStartReason: type: string latestProcedurePriorityCode: type: string latestReferralReceivedDate: type: string format: date latestRttPeriodId: type: string 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 originalReferralSpecialtyId: type: string originalReferralSpecialtyName: type: string owlClinicCode: type: string owlFlag: type: boolean owlGroupCode: type: string pathwayClass: type: string pathwayEndDate: type: string format: date pathwayId: type: string pathwayStage: type: string pathwayStartDate: type: string format: date pathwayStatus: type: string pathwaySubtype: type: string pathwayType: type: string patientDeceased: type: boolean patientId: type: string patientName: type: string ppid: type: string ppidIssuer: type: string ppidIssuerOdsCode: type: string prospectiveRttPeriodEndDate: type: string format: date prospectiveRttWeeksWait: type: integer referralDate: type: string format: date referralId: type: string referralPriority: type: string referralReceivedDate: type: string format: date referralSource: type: string rvGroupIds: type: array nullable: true 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 waitingTimeMeasurementType: type: string waitingTimeMeasurementTypeCode: type: string waitingTimeMeasurementTypeCodeLocalCode: type: string weeksTo104WeekBreachDate: type: integer weeksTo18WeekBreachDate: type: integer weeksTo52WeekBreachDate: type: integer weeksTo65WeekBreachDate: type: integer weeksTo78WeekBreachDate: type: integer weeksWaitSinceDtaDate: type: integer weeksWaitSinceLastPatientContact: type: integer weeksWaitToProspectiveRttPeriodEndDate: type: integer weeksWaitToTciDate: type: integer Specialty.TheatreSession: 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 anaestheticTypes: type: array nullable: true items: type: string anaesthetistIds: type: array nullable: true items: type: string anaesthetistNames: type: array nullable: true items: type: string anaesthetistRequired: type: boolean bookedMinutes: type: integer bookedUtilisation: type: number format: double bookedUtilisationStatus: type: string bookingCancellationsOnTheDayCount: type: integer bookingCancellationsTotalCount: type: integer cancellationReason: type: string cancelled: type: boolean comments: type: array nullable: true items: type: string consultantIds: type: array nullable: true items: type: string consultantLeaveStatus: type: string consultantNames: type: array nullable: true 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 plannedSessionMinutes: type: integer plannedSessionUtilisation: type: number format: double plannedStartTime: type: string format: date-time pooledList: type: boolean primaryAnaesthetistId: type: string primaryAnaesthetistName: type: string primaryConsultantId: type: string primaryConsultantName: type: string rvGroupIds: type: array nullable: true 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 Specialty.UserPreference: type: object properties: cancerPathwayTags: type: array nullable: true items: type: string cancerPathwayTypes: type: array nullable: true items: type: string cancerSites: type: array nullable: true items: type: string defaultConsultants: type: array nullable: true items: type: string defaultRole: type: string defaultSites: type: array nullable: true items: type: string defaultSpecialties: type: array nullable: true items: type: string notificationChannels: type: array nullable: true items: type: string receiveChangelogRequestNotifications: type: boolean receiveSchedulingNotifications: type: boolean receiveSchedulingUpdateNotifications: type: boolean receiveTheatreManagementNotifications: type: boolean userId: type: string Specialty.ValidatedChangelog: type: object properties: actionType: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserGroup: type: string assignedUserIds: type: array nullable: true items: type: string careProfessionalId: type: string careProfessionalName: type: string changeLogId: type: string closedAt: type: string format: date-time closedBy: type: string commentUser: type: string comments: type: string daysOpen: type: integer description: type: string ealId: type: string encounterId: type: string externalId: type: string freeTextComments: type: string isRtt: type: boolean lastRefreshed: type: string format: date-time mrn: type: string newValue: type: string originatingWaitingListAlertRuleTypes: type: array nullable: true items: type: string originatingWaitingListAlertUniqueIds: type: array nullable: true items: type: string patientId: type: string patientName: type: string preResolved: type: boolean primaryConsultantId: type: string primaryConsultantName: type: string primaryEvidenceSource: type: string priority: type: string propertyToModify: type: string rcsClinicalHarmReview: type: string removalDate: type: string format: date removed: type: boolean requestedBy: type: string requiredAction: type: string resolved: type: boolean secondaryEvidenceSource: type: array nullable: true items: type: string siteId: type: string specialtyId: type: string specialtyName: type: string status: type: string statusUpdatedByUser: type: string statusUpdatedTimestamp: type: string format: date-time taskDueDate: type: string format: date taskPriority: type: string taskType: type: string timestamp: type: string format: date-time title: type: string unresolvedEncounterId: type: string validated: type: string ward: type: string StaffUnavailability.CareProfessional: type: object properties: careProfessionalId: type: string careProfessionalLocalId: type: string isActive: type: boolean localSubSpecialties: type: array nullable: true items: type: string mainSpecialty: type: string mainSpecialtyCode: type: string name: type: string professionalRegistrationBody: type: string professionalRegistrationBodyCode: type: string professionalRegistrationEntryId: type: string role: type: string rvGroupIds: type: array nullable: true items: type: string TestResult.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string TestResult.UecAttendance: type: object properties: acuity: type: string acuitySnomedCtCode: type: string admissionId: type: string ambulanceCallId: type: string ambulanceIncidentId: type: string arrivalMode: type: string arrivalModeSnomedCtCode: type: string arrivalTimestamp: type: string format: date-time attendanceSource: type: string attendanceSourceSite: type: string attendanceSourceSiteOdsCode: type: string attendanceSourceSnomedCtCode: type: string chiefComplaint: type: string chiefComplaintSnomedCtCode: type: string clinicallyReadyToProceedTimestamp: type: string format: date-time consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string conveyingAmbulanceTrust: type: string conveyingAmbulanceTrustOdsCode: type: string decisionToAdmitTimestamp: type: string format: date-time departureTimestamp: type: string format: date-time dischargeDestination: type: string dischargeDestinationSnomedCtCode: type: string dischargeFollowUp: type: string dischargeFollowUpSnomedCtCode: type: string dischargeSite: type: string dischargeSiteOdsCode: type: string dischargeStatus: type: string dischargeStatusSnomedCtCode: type: string edExtendedCareEpisodeId: type: string emergencyCareDepartmentType: type: string emergencyCareDepartmentTypeCode: type: string emergencyCareDepartmentTypeLocalCode: type: string expectedTreatmentAllocationTimestamp: type: string format: date-time expectedTreatmentTimestamp: type: string format: date-time hasDischargeInformationBeenGiven: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string initialAssessmentTimestamp: type: string format: date-time patientId: type: string rvGroupIds: type: array nullable: true items: type: string safeguardingConcerns: type: array nullable: true items: type: string safeguardingConcernsSnomedCtCodes: type: array nullable: true items: type: string seenForTreatmentTimestamp: type: string format: date-time treatmentSite: type: string treatmentSiteOdsCode: type: string uecAttendanceExternalId: type: string uecAttendanceId: type: string urgentAndEmergencyCareAttendanceCategory: type: string urgentAndEmergencyCareAttendanceCategoryCode: type: string urgentAndEmergencyCareAttendanceCategoryLocalCode: type: string TheatreBooking.BookingRequest: type: object properties: action: type: string amPm: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserGroup: type: string assignedUserIds: type: array nullable: true items: type: string bookingRequestId: type: string closedAt: type: string format: date-time closedBy: type: string comment: type: string consultantId: type: string date: type: string format: date encounterEstimatedTotalTheatreTime: type: integer encounterId: type: string intendedPrimaryProcedureDescription: type: string intendedPrimaryProcedureFreeText: type: string mnemonic: type: string mrn: type: string personId: type: string reason: type: string specialtyId: type: string status: type: string taskDueDate: type: string format: date taskPriority: type: string taskType: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreName: type: string theatreSessionId: type: string theatreSessionPlannedDurationMinutes: type: integer theatreSessionPrimaryConsultantId: type: string timestamp: type: string format: date-time title: type: string type: type: string updatedAt: type: string format: date-time updatedBy: type: string userId: type: string TheatreBooking.CareProfessional: type: object properties: careProfessionalId: type: string careProfessionalLocalId: type: string isActive: type: boolean localSubSpecialties: type: array nullable: true items: type: string mainSpecialty: type: string mainSpecialtyCode: type: string name: type: string professionalRegistrationBody: type: string professionalRegistrationBodyCode: type: string professionalRegistrationEntryId: type: string role: type: string rvGroupIds: type: array nullable: true items: type: string TheatreBooking.EalEntry: 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 earliestClinicallyAppropriateDate: type: string format: date earliestReasonableOfferDate: type: string format: date episodeId: type: string hasRttPathwayDescription: type: string intendedManagement: type: string intendedManagementCode: type: string intendedManagementLocalCode: type: string isRtt: type: boolean latestClinicallyAppropriateDate: type: string format: date 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 nullable: true items: type: string title: type: string TheatreBooking.Encounter: type: object properties: administrativeCategoryCode: type: string administrativeCategoryDescription: type: string admissionMethod: type: string admissionOfferTimestamp: type: string format: date-time admissionStatus: type: string admissionSubStatus: type: string admissionType: type: string atsTotalTheatreTime: type: integer calculatedTotalTheatreTime: type: integer cancerPriorityOrdering: type: integer createdBy: type: string createdDate: type: string format: date criticalCareBedStatus: type: string division: type: string ealId: type: string encounterFreeText: type: string encounterId: type: string encounterType: type: string estimatedTotalTheatreTime: type: integer externalId: type: string genericWaitlistEntryId: type: string hasDateInTheLastNDays: type: boolean 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 isAdmissionOfferTimestampInTheLastNDays: type: boolean isBooked: type: boolean isMetricEncounter: type: boolean isSuitableForPooledList: type: boolean isSurgicalOrderDateInTheLastNDays: type: boolean isTciDateInTheLastNDays: type: boolean issues: type: array nullable: true items: type: string lastCovidSwabBookingStatus: type: string lastCovidSwabOutcome: type: string lastMrsaSwabBookingStatus: type: string lastMrsaSwabOutcome: type: string lastPoaBookingStatus: type: string lastPoaExpiryDate: type: string format: date lastPoaOutcome: type: string lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string lastPoaScheduledOrAttendedDatetime: type: string format: date-time lastRefreshedAtSourceTimestamp: 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 periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string site: type: string siteId: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string surgicalOrderDate: type: string format: date 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 TheatreBooking.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string TheatreBooking.Procedure: type: object properties: actualProcedureTimeKnifeToSkinClosure: type: integer actualProcedureTimeTotalTheatreTime: type: integer admissionId: type: string admissionMethodDescription: type: string anaestheticTypeToBeUsed: type: string anaesthetistRequired: type: boolean appointmentId: type: string consultantEpisodeId: type: string 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 procedure: type: string procedureDate: type: string format: date procedureId: type: string procedureOpcsCode: type: string procedureOrdered: type: integer procedureSnomedCtCode: type: string procedureTimeOrOrder: type: string procedureTimestamp: type: string format: date-time responsibleAnaesthetistCareProfessionalId: type: string rvGroupIds: type: array nullable: true items: type: string theatreSessionId: type: string title: type: string uecAttendanceId: type: string virtualWardStayId: type: string TheatreBooking.ProcedureStatus: 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 poaExpiryDate: type: string format: date poaOrdering: type: integer poaOutcome: type: string poaOutcomeDate: type: string format: date poaOutcomeFreeText: type: string poaScheduledOrAttendedDatetime: type: string format: date-time procedureId: type: string procedureStatusId: type: string rvGroupIds: type: array nullable: true items: type: string theatreBookingId: type: string TheatreBooking.TheatreSession: 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 anaestheticTypes: type: array nullable: true items: type: string anaesthetistIds: type: array nullable: true items: type: string anaesthetistNames: type: array nullable: true items: type: string anaesthetistRequired: type: boolean bookedMinutes: type: integer bookedUtilisation: type: number format: double bookedUtilisationStatus: type: string bookingCancellationsOnTheDayCount: type: integer bookingCancellationsTotalCount: type: integer cancellationReason: type: string cancelled: type: boolean comments: type: array nullable: true items: type: string consultantIds: type: array nullable: true items: type: string consultantLeaveStatus: type: string consultantNames: type: array nullable: true 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 plannedSessionMinutes: type: integer plannedSessionUtilisation: type: number format: double plannedStartTime: type: string format: date-time pooledList: type: boolean primaryAnaesthetistId: type: string primaryAnaesthetistName: type: string primaryConsultantId: type: string primaryConsultantName: type: string rvGroupIds: type: array nullable: true 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 TheatreSession.BookingRequest: type: object properties: action: type: string amPm: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserGroup: type: string assignedUserIds: type: array nullable: true items: type: string bookingRequestId: type: string closedAt: type: string format: date-time closedBy: type: string comment: type: string consultantId: type: string date: type: string format: date encounterEstimatedTotalTheatreTime: type: integer encounterId: type: string intendedPrimaryProcedureDescription: type: string intendedPrimaryProcedureFreeText: type: string mnemonic: type: string mrn: type: string personId: type: string reason: type: string specialtyId: type: string status: type: string taskDueDate: type: string format: date taskPriority: type: string taskType: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreName: type: string theatreSessionId: type: string theatreSessionPlannedDurationMinutes: type: integer theatreSessionPrimaryConsultantId: type: string timestamp: type: string format: date-time title: type: string type: type: string updatedAt: type: string format: date-time updatedBy: type: string userId: type: string TheatreSession.CareProfessional: type: object properties: careProfessionalId: type: string careProfessionalLocalId: type: string isActive: type: boolean localSubSpecialties: type: array nullable: true items: type: string mainSpecialty: type: string mainSpecialtyCode: type: string name: type: string professionalRegistrationBody: type: string professionalRegistrationBodyCode: type: string professionalRegistrationEntryId: type: string role: type: string rvGroupIds: type: array nullable: true items: type: string TheatreSession.Procedure: type: object properties: actualProcedureTimeKnifeToSkinClosure: type: integer actualProcedureTimeTotalTheatreTime: type: integer admissionId: type: string admissionMethodDescription: type: string anaestheticTypeToBeUsed: type: string anaesthetistRequired: type: boolean appointmentId: type: string consultantEpisodeId: type: string 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 procedure: type: string procedureDate: type: string format: date procedureId: type: string procedureOpcsCode: type: string procedureOrdered: type: integer procedureSnomedCtCode: type: string procedureTimeOrOrder: type: string procedureTimestamp: type: string format: date-time responsibleAnaesthetistCareProfessionalId: type: string rvGroupIds: type: array nullable: true items: type: string theatreSessionId: type: string title: type: string uecAttendanceId: type: string virtualWardStayId: type: string TheatreSession.Specialty: type: object properties: isActiveSpecialty: type: boolean rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string theatreSpecialty: type: boolean TheatreSession.TheatreBooking: 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 lastPoaExpiryDate: type: string format: date lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string mrn: type: string patientId: type: string periOpRiskStratificationOutcome: type: string periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string status: type: string statusRender: type: string tciTimestamp: type: string format: date-time theatreBookingId: type: string theatreSessionDate: type: string format: date theatreSessionId: type: string TheatreSession.TheatreSessionComment: type: object properties: commentHistory: type: array nullable: true items: type: string commentId: type: string commentText: type: string commentTimestamp: type: string format: date-time commentUpdatedTimestamp: type: string format: date-time commentUser: type: string reason: type: string status: type: string tags: type: array nullable: true items: type: string theatreSessionId: type: string updatedBy: type: string TheatreSessionComment.TheatreSession: 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 anaestheticTypes: type: array nullable: true items: type: string anaesthetistIds: type: array nullable: true items: type: string anaesthetistNames: type: array nullable: true items: type: string anaesthetistRequired: type: boolean bookedMinutes: type: integer bookedUtilisation: type: number format: double bookedUtilisationStatus: type: string bookingCancellationsOnTheDayCount: type: integer bookingCancellationsTotalCount: type: integer cancellationReason: type: string cancelled: type: boolean comments: type: array nullable: true items: type: string consultantIds: type: array nullable: true items: type: string consultantLeaveStatus: type: string consultantNames: type: array nullable: true 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 plannedSessionMinutes: type: integer plannedSessionUtilisation: type: number format: double plannedStartTime: type: string format: date-time pooledList: type: boolean primaryAnaesthetistId: type: string primaryAnaesthetistName: type: string primaryConsultantId: type: string primaryConsultantName: type: string rvGroupIds: type: array nullable: true 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 TransferOfCareRequest.Admission: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string admissionExternalId: type: string admissionId: type: string admissionMethod: type: string admissionSource: type: string admissionSourceCode: type: string admissionSourceLocalCode: type: string admissionStatus: type: string admissionTimestamp: type: string format: date-time admissionTitle: type: string admissionType: type: string bedLocation: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string destinationOfDischargeLocalCode: type: string dischargeDestinationType: type: string dischargePathway: type: string dischargeReadyDate: type: string format: date dischargeTimestamp: type: string format: date-time ealEntryId: type: string encounterId: type: string estimatedDischargeDate: type: string format: date-time isDischargeTimeConfirmed: type: boolean localAuthority: type: string methodOfAdmission: type: string methodOfAdmissionCode: type: string methodOfAdmissionLocalCode: type: string methodOfDischarge: type: string methodOfDischargeCode: type: string methodOfDischargeLocalCode: type: string pathwayId: type: string patientClassification: type: string patientClassificationCode: type: string patientClassificationLocalCode: type: string patientId: type: string patientName: type: string rvGroupIds: type: array nullable: true items: type: string siteName: type: string specialtyId: type: string specialtyName: type: string startTimestamp: type: string format: date-time treatmentFunctionCode: type: string ward: type: string wasPatientDischargedToNhsAtHomeService: type: boolean TransferOfCareRequest.CareService: type: object properties: careServiceId: type: string createdAt: type: string format: date-time createdBy: type: string description: type: string modules: type: array nullable: true items: type: string name: type: string status: type: string updatedAt: type: string format: date-time updatedBy: type: string UecAttendance.AssignedCareProfessional: type: object properties: appointmentId: type: string assignedCareProfessionalId: type: string careProfessionalId: type: string clinicalResponsibilityTimestamp: type: string format: date-time consultantEpisodeId: type: string isResponsibleCareProfessional: type: boolean isResponsibleForEdDischarge: type: boolean rvGroupIds: type: array nullable: true items: type: string uecAttendanceId: type: string UecAttendance.EMed3FitNote: type: object properties: admissionId: type: string applicablePeriodDurationDays: type: integer appointmentId: type: string assessmentDate: type: string format: date condition: type: string conditionIcd10Code: type: string conditionSnomedCtCode: type: string emed3FitNoteId: type: string emed3FitNoteIssuer: type: string emed3FitNoteIssuerCode: type: string emed3FitNoteIssuerLocalCode: type: string endDate: type: string format: date isFollowUpAssessmentRequired: type: boolean patientId: type: string recordedDate: type: string format: date rvGroupIds: type: array nullable: true items: type: string startDate: type: string format: date uecAttendanceId: type: string UecAttendance.Injury: type: object properties: alcoholOrDrugInvolvementSnomedCtCodes: type: array nullable: true items: type: string alcoholOrDrugInvolvements: type: array nullable: true items: type: string assaultLocationDescription: type: string injuryActivityStatus: type: string injuryActivityStatusSnomedCtCode: type: string injuryActivityType: type: string injuryActivityTypeSnomedCtCode: type: string injuryId: type: string injuryIntent: type: string injuryIntentSnomedCtCode: type: string injuryMechanism: type: string injuryMechanismSnomedCtCode: type: string injuryTimestamp: type: string format: date-time patientId: type: string placeOfInjury: type: string placeOfInjuryLatitudeDegrees: type: number format: double placeOfInjuryLongitudeDegrees: type: number format: double placeOfInjurySnomedCtCode: type: string rvGroupIds: type: array nullable: true items: type: string uecAttendanceId: type: string UecAttendance.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string UecAttendance.PatientDiagnosis: type: object properties: active: type: string admissionId: type: string consultantEpisodeId: type: string diagnosisEndDate: type: string format: date diagnosisIcd10Code: type: string diagnosisId: type: string diagnosisName: type: string diagnosisSnomedCtCode: type: string diagnosisStartDate: type: string format: date diagnosisTimestamp: type: string format: date-time encounterId: type: string isPrimaryDiagnosis: type: boolean patientId: type: string patientPathwayId: type: string rvGroupIds: type: array nullable: true items: type: string uecAttendanceId: type: string virtualWardStayId: type: string UecAttendance.Procedure: type: object properties: actualProcedureTimeKnifeToSkinClosure: type: integer actualProcedureTimeTotalTheatreTime: type: integer admissionId: type: string admissionMethodDescription: type: string anaestheticTypeToBeUsed: type: string anaesthetistRequired: type: boolean appointmentId: type: string consultantEpisodeId: type: string 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 procedure: type: string procedureDate: type: string format: date procedureId: type: string procedureOpcsCode: type: string procedureOrdered: type: integer procedureSnomedCtCode: type: string procedureTimeOrOrder: type: string procedureTimestamp: type: string format: date-time responsibleAnaesthetistCareProfessionalId: type: string rvGroupIds: type: array nullable: true items: type: string theatreSessionId: type: string title: type: string uecAttendanceId: type: string virtualWardStayId: type: string UecAttendance.ScoredAssessment: type: object properties: admissionId: type: string appointmentId: type: string assessmentToolType: type: string assessmentToolTypeSnomedCtCode: type: string completionTimestamp: type: string format: date-time consultantEpisodeId: type: string patientId: type: string personScore: type: string rvGroupIds: type: array nullable: true items: type: string scoredAssessmentId: type: string uecAttendanceId: type: string virtualWardStayId: type: string UecAttendance.TestResult: type: object properties: attendanceId: type: string expiryDate: type: string format: date-time lastRefreshedAtSourceTimestamp: type: string format: date-time orderingSpecialtyName: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string sourceSystemNames: type: array nullable: true items: type: string testDate: type: string format: date-time testId: type: string testName: type: string testOrderedTimestamp: type: string format: date-time testResultId: type: string testValueType: type: string uecAttendanceId: type: string unit: type: string value: type: string valueDouble: type: number format: double UecAttendance.UecReferral: type: object properties: patientId: type: string referralTimestamp: type: string format: date-time referredToService: type: string referredToServiceAssessmentTimestamp: type: string format: date-time referredToServiceSnomedCtCode: type: string rvGroupIds: type: array nullable: true items: type: string uecAttendanceId: type: string uecReferralId: type: string UecReferral.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string UecReferral.UecAttendance: type: object properties: acuity: type: string acuitySnomedCtCode: type: string admissionId: type: string ambulanceCallId: type: string ambulanceIncidentId: type: string arrivalMode: type: string arrivalModeSnomedCtCode: type: string arrivalTimestamp: type: string format: date-time attendanceSource: type: string attendanceSourceSite: type: string attendanceSourceSiteOdsCode: type: string attendanceSourceSnomedCtCode: type: string chiefComplaint: type: string chiefComplaintSnomedCtCode: type: string clinicallyReadyToProceedTimestamp: type: string format: date-time consultationMechanism: type: string consultationMechanismCode: type: string consultationMechanismLocalCode: type: string conveyingAmbulanceTrust: type: string conveyingAmbulanceTrustOdsCode: type: string decisionToAdmitTimestamp: type: string format: date-time departureTimestamp: type: string format: date-time dischargeDestination: type: string dischargeDestinationSnomedCtCode: type: string dischargeFollowUp: type: string dischargeFollowUpSnomedCtCode: type: string dischargeSite: type: string dischargeSiteOdsCode: type: string dischargeStatus: type: string dischargeStatusSnomedCtCode: type: string edExtendedCareEpisodeId: type: string emergencyCareDepartmentType: type: string emergencyCareDepartmentTypeCode: type: string emergencyCareDepartmentTypeLocalCode: type: string expectedTreatmentAllocationTimestamp: type: string format: date-time expectedTreatmentTimestamp: type: string format: date-time hasDischargeInformationBeenGiven: type: boolean healthcareProvider: type: string healthcareProviderOdsCode: type: string initialAssessmentTimestamp: type: string format: date-time patientId: type: string rvGroupIds: type: array nullable: true items: type: string safeguardingConcerns: type: array nullable: true items: type: string safeguardingConcernsSnomedCtCodes: type: array nullable: true items: type: string seenForTreatmentTimestamp: type: string format: date-time treatmentSite: type: string treatmentSiteOdsCode: type: string uecAttendanceExternalId: type: string uecAttendanceId: type: string urgentAndEmergencyCareAttendanceCategory: type: string urgentAndEmergencyCareAttendanceCategoryCode: type: string urgentAndEmergencyCareAttendanceCategoryLocalCode: type: string UserPreference.CareProfessional: type: object properties: careProfessionalId: type: string careProfessionalLocalId: type: string isActive: type: boolean localSubSpecialties: type: array nullable: true items: type: string mainSpecialty: type: string mainSpecialtyCode: type: string name: type: string professionalRegistrationBody: type: string professionalRegistrationBodyCode: type: string professionalRegistrationEntryId: type: string role: type: string rvGroupIds: type: array nullable: true items: type: string UserPreference.Specialty: type: object properties: isActiveSpecialty: type: boolean rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string theatreSpecialty: type: boolean ValidatedChangeLogComment.ValidatedChangelog: type: object properties: actionType: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserGroup: type: string assignedUserIds: type: array nullable: true items: type: string careProfessionalId: type: string careProfessionalName: type: string changeLogId: type: string closedAt: type: string format: date-time closedBy: type: string commentUser: type: string comments: type: string daysOpen: type: integer description: type: string ealId: type: string encounterId: type: string externalId: type: string freeTextComments: type: string isRtt: type: boolean lastRefreshed: type: string format: date-time mrn: type: string newValue: type: string originatingWaitingListAlertRuleTypes: type: array nullable: true items: type: string originatingWaitingListAlertUniqueIds: type: array nullable: true items: type: string patientId: type: string patientName: type: string preResolved: type: boolean primaryConsultantId: type: string primaryConsultantName: type: string primaryEvidenceSource: type: string priority: type: string propertyToModify: type: string rcsClinicalHarmReview: type: string removalDate: type: string format: date removed: type: boolean requestedBy: type: string requiredAction: type: string resolved: type: boolean secondaryEvidenceSource: type: array nullable: true items: type: string siteId: type: string specialtyId: type: string specialtyName: type: string status: type: string statusUpdatedByUser: type: string statusUpdatedTimestamp: type: string format: date-time taskDueDate: type: string format: date taskPriority: type: string taskType: type: string timestamp: type: string format: date-time title: type: string unresolvedEncounterId: type: string validated: type: string ward: type: string ValidatedChangelog.CareProfessional: type: object properties: careProfessionalId: type: string careProfessionalLocalId: type: string isActive: type: boolean localSubSpecialties: type: array nullable: true items: type: string mainSpecialty: type: string mainSpecialtyCode: type: string name: type: string professionalRegistrationBody: type: string professionalRegistrationBodyCode: type: string professionalRegistrationEntryId: type: string role: type: string rvGroupIds: type: array nullable: true items: type: string ValidatedChangelog.ChangeLogRequest: type: object properties: actionType: type: string assignedTeamId: type: string assignedTeamName: type: string assignedUserIds: type: array nullable: true items: type: string careProfessionalId: type: string careProfessionalName: type: string changeLogId: type: string closedAt: type: string format: date-time closedBy: type: string description: type: string ealId: type: string encounterId: type: string freeTextComments: type: string isRTT: type: boolean newValue: type: string originatingWaitingListAlertRuleIds: type: array nullable: true items: type: string originatingWaitingListAlertRuleTypes: type: array nullable: true items: type: string preResolved: type: boolean primaryEvidenceSource: type: string propertyToModify: type: string rcsClinicalHarmReview: type: string requestedBy: type: string resolved: type: boolean secondaryEvidenceSource: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string taskDueDate: type: string format: date taskPriority: type: string taskType: type: string timestamp: type: string format: date-time ValidatedChangelog.Encounter: type: object properties: administrativeCategoryCode: type: string administrativeCategoryDescription: type: string admissionMethod: type: string admissionOfferTimestamp: type: string format: date-time admissionStatus: type: string admissionSubStatus: type: string admissionType: type: string atsTotalTheatreTime: type: integer calculatedTotalTheatreTime: type: integer cancerPriorityOrdering: type: integer createdBy: type: string createdDate: type: string format: date criticalCareBedStatus: type: string division: type: string ealId: type: string encounterFreeText: type: string encounterId: type: string encounterType: type: string estimatedTotalTheatreTime: type: integer externalId: type: string genericWaitlistEntryId: type: string hasDateInTheLastNDays: type: boolean 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 isAdmissionOfferTimestampInTheLastNDays: type: boolean isBooked: type: boolean isMetricEncounter: type: boolean isSuitableForPooledList: type: boolean isSurgicalOrderDateInTheLastNDays: type: boolean isTciDateInTheLastNDays: type: boolean issues: type: array nullable: true items: type: string lastCovidSwabBookingStatus: type: string lastCovidSwabOutcome: type: string lastMrsaSwabBookingStatus: type: string lastMrsaSwabOutcome: type: string lastPoaBookingStatus: type: string lastPoaExpiryDate: type: string format: date lastPoaOutcome: type: string lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string lastPoaScheduledOrAttendedDatetime: type: string format: date-time lastRefreshedAtSourceTimestamp: 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 periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string site: type: string siteId: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string surgicalOrderDate: type: string format: date 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 ValidatedChangelog.Specialty: type: object properties: isActiveSpecialty: type: boolean rvGroupIds: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string theatreSpecialty: type: boolean ValidatedChangelog.ValidatedChangeLogComment: type: object properties: changeLogId: type: string commentId: type: string commentMarkdown: type: string commentText: type: string commentTimestamp: type: string format: date-time commentUser: type: string taskAction: type: string VirtualWard.VirtualWardStay: type: object properties: activityLocationType: type: string activityLocationTypeCode: type: string admissionSource: type: string admissionSourceCode: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string endTimestamp: type: string format: date-time expectedCommissioner: type: string expectedCommissionerOdsCode: type: string isPatientSubjectToRemoteMonitoring: type: boolean methodOfDischarge: type: string methodOfDischargeCode: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time trustOdsCode: type: string virtualWardId: type: string virtualWardStayId: type: string VirtualWardStay.Finding: type: object properties: findingCtv3code: type: string findingId: type: string rvGroupIds: type: array nullable: true items: type: string virtualWardStayId: type: string VirtualWardStay.Observation: type: object properties: observationCtv3code: type: string observationId: type: string patientId: type: string rvGroupIds: type: array nullable: true items: type: string virtualWardStayId: type: string VirtualWardStay.PatientDiagnosis: type: object properties: active: type: string admissionId: type: string consultantEpisodeId: type: string diagnosisEndDate: type: string format: date diagnosisIcd10Code: type: string diagnosisId: type: string diagnosisName: type: string diagnosisSnomedCtCode: type: string diagnosisStartDate: type: string format: date diagnosisTimestamp: type: string format: date-time encounterId: type: string isPrimaryDiagnosis: type: boolean patientId: type: string patientPathwayId: type: string rvGroupIds: type: array nullable: true items: type: string uecAttendanceId: type: string virtualWardStayId: type: string VirtualWardStay.Procedure: type: object properties: actualProcedureTimeKnifeToSkinClosure: type: integer actualProcedureTimeTotalTheatreTime: type: integer admissionId: type: string admissionMethodDescription: type: string anaestheticTypeToBeUsed: type: string anaesthetistRequired: type: boolean appointmentId: type: string consultantEpisodeId: type: string 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 procedure: type: string procedureDate: type: string format: date procedureId: type: string procedureOpcsCode: type: string procedureOrdered: type: integer procedureSnomedCtCode: type: string procedureTimeOrOrder: type: string procedureTimestamp: type: string format: date-time responsibleAnaesthetistCareProfessionalId: type: string rvGroupIds: type: array nullable: true items: type: string theatreSessionId: type: string title: type: string uecAttendanceId: type: string virtualWardStayId: type: string VirtualWardStay.ScoredAssessment: type: object properties: admissionId: type: string appointmentId: type: string assessmentToolType: type: string assessmentToolTypeSnomedCtCode: type: string completionTimestamp: type: string format: date-time consultantEpisodeId: type: string patientId: type: string personScore: type: string rvGroupIds: type: array nullable: true items: type: string scoredAssessmentId: type: string uecAttendanceId: type: string virtualWardStayId: type: string VirtualWardStay.VirtualWard: type: object properties: closureDate: type: string format: date isPointOfCareTestingAvailable: type: boolean isTechnologyEnabled: type: boolean maxCapacity: type: integer openingDate: type: string format: date primaryDataCollectionSystem: type: string rvGroupIds: type: array nullable: true items: type: string trustOdsCode: type: string virtualWardCode: type: string virtualWardId: type: string virtualWardName: type: string Waitlist.WaitlistEntry: type: object properties: addedTimestamp: type: string format: date-time dueDate: type: string format: date pathwayId: type: string removedTimestamp: type: string format: date-time rvGroupIds: type: array nullable: true items: type: string waitlistEntryId: type: string waitlistId: type: string WaitlistEntry.Encounter: type: object properties: administrativeCategoryCode: type: string administrativeCategoryDescription: type: string admissionMethod: type: string admissionOfferTimestamp: type: string format: date-time admissionStatus: type: string admissionSubStatus: type: string admissionType: type: string atsTotalTheatreTime: type: integer calculatedTotalTheatreTime: type: integer cancerPriorityOrdering: type: integer createdBy: type: string createdDate: type: string format: date criticalCareBedStatus: type: string division: type: string ealId: type: string encounterFreeText: type: string encounterId: type: string encounterType: type: string estimatedTotalTheatreTime: type: integer externalId: type: string genericWaitlistEntryId: type: string hasDateInTheLastNDays: type: boolean 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 isAdmissionOfferTimestampInTheLastNDays: type: boolean isBooked: type: boolean isMetricEncounter: type: boolean isSuitableForPooledList: type: boolean isSurgicalOrderDateInTheLastNDays: type: boolean isTciDateInTheLastNDays: type: boolean issues: type: array nullable: true items: type: string lastCovidSwabBookingStatus: type: string lastCovidSwabOutcome: type: string lastMrsaSwabBookingStatus: type: string lastMrsaSwabOutcome: type: string lastPoaBookingStatus: type: string lastPoaExpiryDate: type: string format: date lastPoaOutcome: type: string lastPoaOutcomeDate: type: string format: date lastPoaOutcomeFreeText: type: string lastPoaScheduledOrAttendedDatetime: type: string format: date-time lastRefreshedAtSourceTimestamp: 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 periOpRiskStratificationOutcomeDate: type: string format: date 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 nullable: true items: type: string site: type: string siteId: type: string sourceSystemNames: type: array nullable: true items: type: string specialtyId: type: string specialtyName: type: string surgicalOrderDate: type: string format: date 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 WaitlistEntry.OutpatientActivity: 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 genericWaitlistEntryId: type: string isPrivate: type: boolean isReferral: type: boolean issues: type: array nullable: true 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 nullable: true 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 WaitlistEntry.Waitlist: type: object properties: rvGroupIds: type: array nullable: true items: type: string waitlistId: type: string waitlistName: type: string Ward.WardStay: type: object properties: admissionId: type: string endTimestamp: type: string format: date-time patientId: type: string rvGroupIds: type: array nullable: true items: type: string startTimestamp: type: string format: date-time wardId: type: string wardStayId: type: string WardStay.Admission: type: object properties: administrativeCategory: type: string administrativeCategoryCode: type: string administrativeCategoryLocalCode: type: string admissionExternalId: type: string admissionId: type: string admissionMethod: type: string admissionSource: type: string admissionSourceCode: type: string admissionSourceLocalCode: type: string admissionStatus: type: string admissionTimestamp: type: string format: date-time admissionTitle: type: string admissionType: type: string bedLocation: type: string destinationOfDischarge: type: string destinationOfDischargeCode: type: string destinationOfDischargeLocalCode: type: string dischargeDestinationType: type: string dischargePathway: type: string dischargeReadyDate: type: string format: date dischargeTimestamp: type: string format: date-time ealEntryId: type: string encounterId: type: string estimatedDischargeDate: type: string format: date-time isDischargeTimeConfirmed: type: boolean localAuthority: type: string methodOfAdmission: type: string methodOfAdmissionCode: type: string methodOfAdmissionLocalCode: type: string methodOfDischarge: type: string methodOfDischargeCode: type: string methodOfDischargeLocalCode: type: string pathwayId: type: string patientClassification: type: string patientClassificationCode: type: string patientClassificationLocalCode: type: string patientId: type: string patientName: type: string rvGroupIds: type: array nullable: true items: type: string siteName: type: string specialtyId: type: string specialtyName: type: string startTimestamp: type: string format: date-time treatmentFunctionCode: type: string ward: type: string wasPatientDischargedToNhsAtHomeService: type: boolean WardStay.Patient: type: object properties: accessibleInformationProfessionalRequired: type: string accessibleInformationProfessionalRequiredSnomedCtCode: type: string accommodationStatus: type: string accommodationStatusCode: type: string accommodationStatusLocalCode: type: string activeAdditionalNeeds: type: array nullable: true items: type: string addressCity: type: string addressLine1: type: string addressLine2: type: string age: type: string format: long dateOfBirth: type: string format: date dateOfDeath: type: string format: date deceased: type: boolean email: type: string ethnicCategory: type: string ethnicCategoryCode: type: string ethnicCategoryLocalCode: type: string firstName: type: string fullName: type: string genderIdentity: type: string genderIdentityCode: type: string interpreterLanguage: type: string interpreterLanguageSnomedCtCode: type: string isCarerSupportAvailable: type: boolean localAuthority: type: string mrn: type: string nextOfKinName: type: string nextOfKinNumber: type: string nextOfKinNumberSecondary: type: string nextOfKinRelationshipType: type: string nhsNumber: type: string nhsNumberStatusIndicator: type: string nhsNumberStatusIndicatorCode: type: string nhsNumberStatusIndicatorLocalCode: type: string patientExternalId: type: string personId: type: string personMaritalStatus: type: string personMaritalStatusCode: type: string personMaritalStatusLocalCode: type: string phenotypicSex: type: string phenotypicSexCode: type: string phoneNumber: type: string phoneNumberSecondary: type: string postcode: type: string preferredSpokenLanguage: type: string preferredSpokenLanguageSnomedCtCode: type: string registeredGp: type: string rvGroupIds: type: array nullable: true items: type: string school: type: string sex: type: string statedGender: type: string statedGenderCode: type: string surname: type: string temporaryAddressCity: type: string temporaryAddressLine1: type: string temporaryAddressLine2: type: string temporaryPostcode: type: string title: type: string WardStay.Ward: type: object properties: division: type: string rvGroupIds: type: array nullable: true items: type: string site: type: string siteOdsCode: type: string trust: type: string trustOdsCode: type: string wardCode: type: string wardId: type: string wardIntendedAgeGroup: type: string wardIntendedAgeGroupCode: type: string wardIntendedAgeGroupLocalCode: type: string wardIntendedClinicalCareIntensity: type: string wardIntendedClinicalCareIntensityCode: type: string wardIntendedClinicalCareIntensityLocalCode: type: string wardIntendedDayPeriodAvailabilityDays: type: integer wardIntendedNightPeriodAvailabilityDays: type: integer wardIntendedSexOfPatients: type: string wardIntendedSexOfPatientsCode: type: string wardIntendedSexOfPatientsLocalCode: type: string wardName: type: string wardSecurityLevel: type: string wardSecurityLevelCode: type: string wardSecurityLevelLocalCode: type: string securitySchemes: BearerAuth: type: http scheme: bearer