{"items":[{"type":"link","label":"xCures API","link":"/apis/current","routeSlug":"/apis/current","content":{"contentType":"overview","meta":{"name":"xCures API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"current.json","url":"/_bundle/apis/current.json?download"},{"kind":"download","label":"current.yaml","url":"/_bundle/apis/current.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"python","title":"Python","lang":"Python"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"java","title":"Java","lang":"Java"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"ruby","title":"Ruby","lang":"Ruby"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://partner.xcures.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"xCures API (V1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/apis/current"}],"sectionId":"/apis/current"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our API requires a Bearer Token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for auth. Most of our endpoints also require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to set the context of the request. It must be one of the projects the api client has permissions to."},"children":[]}]}]}]}],"sectionId":"/apis/current/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication/getting-a-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting a token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a token, use your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to execute a client credentials exchange."},"children":[]}]}]}]}],"sectionId":"/apis/current/section/authentication/getting-a-token"}],"sectionId":"/apis/current/section/authentication/getting-a-token"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/authentication/example-curl-command:"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example CURL command:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"curl --request POST "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"--url https://partner.xcures.com/oauth/token "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"--header 'content-type: application/json' "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"--data '{\"client_id\":\"{your_client_id}\",\"client_secret\":\"{your_client_secret}\",\"grant_type\":\"client_credentials\"}'"},"children":[]}]}]}]}],"sectionId":"/apis/current/section/authentication/example-curl-command:"}],"sectionId":"/apis/current/section/authentication/example-curl-command:"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/authentication/response:"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"access_token\": \"{your_temporary_access_token}\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"token_type\": \"Bearer\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}"},"children":[]}]}]}]}],"sectionId":"/apis/current/section/authentication/response:"}],"sectionId":"/apis/current/section/authentication/response:"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication/using-the-token-with-our-api:"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using the token with our API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Now just include that bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of your requests to our API."},"children":[]}]}]}]}],"sectionId":"/apis/current/section/authentication/using-the-token-with-our-api:"}],"sectionId":"/apis/current/section/authentication/using-the-token-with-our-api:"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/authentication/example-authorized-request:"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example authorized request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"curl --request GET "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"--url https://partner.xcures.com/api/v1/patient-registry/subject "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"--header 'ProjectId: {your_project_id}' "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"--header 'authorization: Bearer {your_temporary_access_token}'"},"children":[]}]}]}]}],"sectionId":"/apis/current/section/authentication/example-authorized-request:"}],"sectionId":"/apis/current/section/authentication/example-authorized-request:"}]}]}},{"type":"group","label":"Authentication","link":"/apis/current/section/authentication","routeSlug":"/apis/current/section/authentication","items":[{"type":"link","label":"Getting a token","link":"/apis/current/section/authentication/getting-a-token","routeSlug":"/apis/current/section/authentication/getting-a-token","content":null},{"type":"link","label":"Example CURL command:","link":"/apis/current/section/authentication/example-curl-command:","routeSlug":"/apis/current/section/authentication/example-curl-command:","content":null},{"type":"link","label":"Response:","link":"/apis/current/section/authentication/response:","routeSlug":"/apis/current/section/authentication/response:","content":null},{"type":"link","label":"Using the token with our API:","link":"/apis/current/section/authentication/using-the-token-with-our-api:","routeSlug":"/apis/current/section/authentication/using-the-token-with-our-api:","content":null},{"type":"link","label":"Example authorized request:","link":"/apis/current/section/authentication/example-authorized-request:","routeSlug":"/apis/current/section/authentication/example-authorized-request:","content":null}],"content":null},{"type":"group","label":"OAuth","link":"/apis/current/oauth","routeSlug":"/apis/current/oauth","items":[{"label":"Get Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/oauth/publicoauthcontroller_token","routeSlug":"/apis/current/oauth/publicoauthcontroller_token","metadata":{"seo":{"title":"Get Token","description":"Obtain an access token that is authorized to make API calls."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicOAuthController_token","name":"Get Token","isWebhook":false,"pointer":"/paths/~1oauth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Obtain an access token that is authorized to make API calls."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OAuthTokenRequestDto"}},"schemaId":"components/schemas/OAuthTokenRequestDto","pointer":"/paths/~1oauth~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/oauth/token","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/OAuthTokenRequestDto"}},"responseCodes":["200","400","401","429"],"pointer":"/oauth/token","href":"oauth/publicoauthcontroller_token","openApiOperationId":"PublicOAuthController_token","summary":"Get Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"schemaId":"components/schemas/OAuthTokenRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OAuthTokenRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthTokenResponseDto"}},"schemaId":"components/schemas/OAuthTokenResponseDto"},{"code":"400"},{"code":"401"},{"code":"429"}],"pointer":"/paths/~1oauth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OAuthTokenResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthTokenResponseDto"}}},{"code":"400"},{"code":"401"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/oauth/publicoauthcontroller_token"}],"panels":[]}]},"httpPath":"/oauth/token"}],"content":{"contentType":"group","meta":{"name":"OAuth"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OAuth","showPageActions":true},{"nodeType":"markdoc","content":"All API requests to xCures must provide an access token, retrieved via the standard OAuth authorization flow below."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/oauth/token","summary":"Get Token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/oauth/publicoauthcontroller_token","deprecated":false}]}]}]}]}},{"type":"group","label":"Subject","link":"/apis/current/subject","routeSlug":"/apis/current/subject","items":[{"label":"Search Subjects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/subject/publicsubjectcontroller_search","routeSlug":"/apis/current/subject/publicsubjectcontroller_search","metadata":{"seo":{"title":"Search Subjects","description":"Search subjects"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicSubjectController_search","name":"Search Subjects","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1subject/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Subjects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search subjects"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_35","description":"Field name to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"deleted","in":"query","schemaId":"schema_37"},{"name":"identifier","in":"query","schemaId":"schema_38"},{"name":"subjectIds","in":"query","schemaId":"schema_39"},{"name":"firstName","in":"query","schemaId":"schema_38"},{"name":"lastName","in":"query","schemaId":"schema_38"},{"name":"city","in":"query","schemaId":"schema_38"},{"name":"state","in":"query","schemaId":"schema_38"},{"name":"addressLine1","in":"query","schemaId":"schema_38"},{"name":"addressLine2","in":"query","schemaId":"schema_38"},{"name":"postalCode","in":"query","schemaId":"schema_38"},{"name":"gender","in":"query","schemaId":"schema_38"},{"name":"birthDate","in":"query","schemaId":"schema_38"},{"name":"birthDateStart","in":"query","schemaId":"schema_38"},{"name":"birthDateEnd","in":"query","schemaId":"schema_38"},{"name":"deathDate","in":"query","schemaId":"schema_38"},{"name":"deathDateStart","in":"query","schemaId":"schema_38"},{"name":"deathDateEnd","in":"query","schemaId":"schema_38"},{"name":"email","in":"query","schemaId":"schema_38"},{"name":"created","in":"query","schemaId":"schema_38"},{"name":"createdStart","in":"query","schemaId":"schema_38"},{"name":"createdEnd","in":"query","schemaId":"schema_38"},{"name":"updated","in":"query","schemaId":"schema_38"},{"name":"updatedStart","in":"query","schemaId":"schema_38"},{"name":"updatedEnd","in":"query","schemaId":"schema_38"},{"name":"phoneNumber","in":"query","schemaId":"schema_38"},{"name":"externalIdentifiers","in":"query","schemaId":"schema_40"},{"name":"labels","in":"query","schemaId":"schema_40"},{"name":"cohortIds","in":"query","schemaId":"schema_40"},{"name":"programDeliveryId","in":"query","schemaId":"schema_38"},{"name":"programDeliveryStatus","in":"query","schemaId":"schema_38"},{"name":"additionalNames","in":"query","schemaId":"schema_40"},{"name":"totalQueries","in":"query","schemaId":"schema_41"},{"name":"successfulQueries","in":"query","schemaId":"schema_41"},{"name":"inflightQueries","in":"query","schemaId":"schema_41"},{"name":"viewId","in":"query","schemaId":"schema_38"}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/subject","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_35"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"deleted","in":"query","required":false,"schemaId":"schema_37"},{"name":"identifier","in":"query","required":false,"schemaId":"schema_38"},{"name":"subjectIds","in":"query","required":false,"schemaId":"schema_39"},{"name":"firstName","in":"query","required":false,"schemaId":"schema_38"},{"name":"lastName","in":"query","required":false,"schemaId":"schema_38"},{"name":"city","in":"query","required":false,"schemaId":"schema_38"},{"name":"state","in":"query","required":false,"schemaId":"schema_38"},{"name":"addressLine1","in":"query","required":false,"schemaId":"schema_38"},{"name":"addressLine2","in":"query","required":false,"schemaId":"schema_38"},{"name":"postalCode","in":"query","required":false,"schemaId":"schema_38"},{"name":"gender","in":"query","required":false,"schemaId":"schema_38"},{"name":"birthDate","in":"query","required":false,"schemaId":"schema_38"},{"name":"birthDateStart","in":"query","required":false,"schemaId":"schema_38"},{"name":"birthDateEnd","in":"query","required":false,"schemaId":"schema_38"},{"name":"deathDate","in":"query","required":false,"schemaId":"schema_38"},{"name":"deathDateStart","in":"query","required":false,"schemaId":"schema_38"},{"name":"deathDateEnd","in":"query","required":false,"schemaId":"schema_38"},{"name":"email","in":"query","required":false,"schemaId":"schema_38"},{"name":"created","in":"query","required":false,"schemaId":"schema_38"},{"name":"createdStart","in":"query","required":false,"schemaId":"schema_38"},{"name":"createdEnd","in":"query","required":false,"schemaId":"schema_38"},{"name":"updated","in":"query","required":false,"schemaId":"schema_38"},{"name":"updatedStart","in":"query","required":false,"schemaId":"schema_38"},{"name":"updatedEnd","in":"query","required":false,"schemaId":"schema_38"},{"name":"phoneNumber","in":"query","required":false,"schemaId":"schema_38"},{"name":"externalIdentifiers","in":"query","required":false,"schemaId":"schema_40"},{"name":"labels","in":"query","required":false,"schemaId":"schema_40"},{"name":"cohortIds","in":"query","required":false,"schemaId":"schema_40"},{"name":"programDeliveryId","in":"query","required":false,"schemaId":"schema_38"},{"name":"programDeliveryStatus","in":"query","required":false,"schemaId":"schema_38"},{"name":"additionalNames","in":"query","required":false,"schemaId":"schema_40"},{"name":"totalQueries","in":"query","required":false,"schemaId":"schema_41"},{"name":"successfulQueries","in":"query","required":false,"schemaId":"schema_41"},{"name":"inflightQueries","in":"query","required":false,"schemaId":"schema_41"},{"name":"viewId","in":"query","required":false,"schemaId":"schema_38"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/subject","href":"subject/publicsubjectcontroller_search","openApiOperationId":"PublicSubjectController_search","summary":"Search Subjects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubjectPaginationResult"}},"schemaId":"components/schemas/SubjectPaginationResult"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubjectPaginationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubjectPaginationResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subject/publicsubjectcontroller_search"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/subject"},{"label":"Create Subjects","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/subject/publicsubjectcontroller_create","routeSlug":"/apis/current/subject/publicsubjectcontroller_create","metadata":{"seo":{"title":"Create Subjects","description":"Creates all the subjects defined in the array. Maximum of 10 subjects allowed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicSubjectController_create","name":"Create Subjects","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1subject/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Subjects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates all the subjects defined in the array. Maximum of 10 subjects allowed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43","pointer":"/paths/~1api~1v1~1patient-registry~1subject/post/requestBody","description":"Array of subjects to create, or a batch object with subjects array and optional batch-level options. Maximum of 10 subjects allowed."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/patient-registry/subject","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_43"}},"responseCodes":["201","400","401","403","409","429"],"pointer":"/api/v1/patient-registry/subject","href":"subject/publicsubjectcontroller_create","openApiOperationId":"PublicSubjectController_create","summary":"Create Subjects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}},"schemaId":"schema_44"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"409"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_44","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"409"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subject/publicsubjectcontroller_create"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/subject"},{"label":"Get Subject","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/subject/publicsubjectcontroller_get","routeSlug":"/apis/current/subject/publicsubjectcontroller_get","metadata":{"seo":{"title":"Get Subject","description":"Get a specific subject by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicSubjectController_get","name":"Get Subject","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1subject~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Subject","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a specific subject by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/subject/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/subject/{id}","href":"subject/publicsubjectcontroller_get","openApiOperationId":"PublicSubjectController_get","summary":"Get Subject"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subject"}},"schemaId":"components/schemas/Subject"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subject"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subject/publicsubjectcontroller_get"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/subject/{id}"},{"label":"Update Subject","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/subject/publicsubjectcontroller_update","routeSlug":"/apis/current/subject/publicsubjectcontroller_update","metadata":{"seo":{"title":"Update Subject","description":"Update a subject."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicSubjectController_update","name":"Update Subject","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1subject~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Subject","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a subject."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSubject"}},"schemaId":"components/schemas/UpdateSubject","pointer":"/paths/~1api~1v1~1patient-registry~1subject~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/patient-registry/subject/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSubject"}},"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/subject/{id}","href":"subject/publicsubjectcontroller_update","openApiOperationId":"PublicSubjectController_update","summary":"Update Subject"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"schemaId":"components/schemas/UpdateSubject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSubject"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subject"}},"schemaId":"components/schemas/Subject"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subject"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subject/publicsubjectcontroller_update"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/subject/{id}"},{"label":"Get Clinical Concepts Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/subject/publicsubjectcontroller_getclinicalconceptsstatus","routeSlug":"/apis/current/subject/publicsubjectcontroller_getclinicalconceptsstatus","metadata":{"seo":{"title":"Get Clinical Concepts Status","description":"Get information regarding the availability of clinical concepts for a subject."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicSubjectController_getClinicalConceptsStatus","name":"Get Clinical Concepts Status","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1subject~1{id}~1status~1clinical-concepts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concepts Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get information regarding the availability of clinical concepts for a subject."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject~1{id}~1status~1clinical-concepts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject~1{id}~1status~1clinical-concepts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/subject/{id}/status/clinical-concepts","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/subject/{id}/status/clinical-concepts","href":"subject/publicsubjectcontroller_getclinicalconceptsstatus","openApiOperationId":"PublicSubjectController_getClinicalConceptsStatus","summary":"Get Clinical Concepts Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptsStatusDto"}},"schemaId":"components/schemas/ClinicalConceptsStatusDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1subject~1{id}~1status~1clinical-concepts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptsStatusDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptsStatusDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subject/publicsubjectcontroller_getclinicalconceptsstatus"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/subject/{id}/status/clinical-concepts"},{"label":"Create Subject V2","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/subject/publicsubjectcontrollerv2_create","routeSlug":"/apis/current/subject/publicsubjectcontrollerv2_create","metadata":{"seo":{"title":"Create Subject V2","description":"Creates and returns the subject."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicSubjectControllerV2_create","name":"Create Subject V2","isWebhook":false,"pointer":"/paths/~1api~1v2~1patient-registry~1subject/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Subject V2","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates and returns the subject."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v2~1patient-registry~1subject/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSubjectV2"}},"schemaId":"components/schemas/CreateSubjectV2","pointer":"/paths/~1api~1v2~1patient-registry~1subject/post/requestBody","description":"Subject to create."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/patient-registry/subject","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSubjectV2"}},"responseCodes":["201","400","401","403","409","429","500","503"],"pointer":"/api/v2/patient-registry/subject","href":"subject/publicsubjectcontrollerv2_create","openApiOperationId":"PublicSubjectControllerV2_create","summary":"Create Subject V2"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"schemaId":"components/schemas/CreateSubjectV2","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSubjectV2"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subject"}},"schemaId":"components/schemas/Subject"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/400/content/application~1json/example"]},{"code":"401"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/403/content/application~1json/example"]},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/409/content/application~1json/example"]},{"code":"429","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/429/content/application~1json/example"]},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/500/content/application~1json/example"]},{"code":"503","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/503/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/503/content/application~1json/example"]}],"pointer":"/paths/~1api~1v2~1patient-registry~1subject/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Subject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subject"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/400/content/application~1json/example"]}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/500/content/application~1json/example"]}}},{"code":"503","schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/503/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails","exampleIds":["paths/~1api~1v2~1patient-registry~1subject/post/responses/503/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subject/publicsubjectcontrollerv2_create"}],"panels":[]}]},"httpPath":"/api/v2/patient-registry/subject"}],"content":{"contentType":"group","meta":{"name":"Subject"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subject","showPageActions":true},{"nodeType":"markdoc","content":"An individual patient created on the xCures Platform."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/patient-registry/subject","summary":"Search Subjects","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subject/publicsubjectcontroller_search","deprecated":false},{"title":"/api/v1/patient-registry/subject","summary":"Create Subjects","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subject/publicsubjectcontroller_create","deprecated":false},{"title":"/api/v1/patient-registry/subject/{id}","summary":"Get Subject","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subject/publicsubjectcontroller_get","deprecated":false},{"title":"/api/v1/patient-registry/subject/{id}","summary":"Update Subject","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subject/publicsubjectcontroller_update","deprecated":false},{"title":"/api/v1/patient-registry/subject/{id}/status/clinical-concepts","summary":"Get Clinical Concepts Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subject/publicsubjectcontroller_getclinicalconceptsstatus","deprecated":false},{"title":"/api/v2/patient-registry/subject","summary":"Create Subject V2","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subject/publicsubjectcontrollerv2_create","deprecated":false}]}]}]}]}},{"type":"group","label":"Query","link":"/apis/current/query","routeSlug":"/apis/current/query","items":[{"label":"Search Queries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/query/publicquerycontroller_search","routeSlug":"/apis/current/query/publicquerycontroller_search","metadata":{"seo":{"title":"Search Queries","description":"Search Queries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicQueryController_search","name":"Search Queries","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1query/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Queries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search Queries"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_45","description":"Field name to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_46"},{"name":"status","in":"query","schemaId":"schema_47","description":"Filter applies specifically to property ccdaStatus"},{"name":"createdFrom","in":"query","schemaId":"schema_48","description":"Include queries created on or after this date (inclusive)"},{"name":"createdTo","in":"query","schemaId":"schema_48","description":"Include queries created before this date (exclusive)"}],"pointer":"/paths/~1api~1v1~1patient-registry~1query/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1query/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/query","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_45"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":false,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_46"},{"name":"status","in":"query","required":false,"schemaId":"schema_47"},{"name":"createdFrom","in":"query","required":false,"example":"2025-05-26T23:30:40.912Z","schemaId":"schema_48"},{"name":"createdTo","in":"query","required":false,"example":"2025-05-26T23:30:40.912Z","schemaId":"schema_48"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/query","href":"query/publicquerycontroller_search","openApiOperationId":"PublicQueryController_search","summary":"Search Queries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryPaginationResult"}},"schemaId":"components/schemas/QueryPaginationResult"}],"pointer":"/paths/~1api~1v1~1patient-registry~1query/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","schemaId":"components/schemas/QueryPaginationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryPaginationResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/query/publicquerycontroller_search"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/query"},{"label":"Create Query","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/query/publicquerycontroller_create","routeSlug":"/apis/current/query/publicquerycontroller_create","metadata":{"seo":{"title":"Create Query","description":"Create a new query by providing the necessary details. The query will be stored and can be used for further operations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicQueryController_create","name":"Create Query","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Query","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new query by providing the necessary details. The query will be stored and can be used for further operations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateQueryDto","exampleIds":["paths/~1api~1v1~1patient-registry~1query/post/requestBody/content/application~1json/examples/example1"]}},"schemaId":"components/schemas/CreateQueryDto","exampleIds":["paths/~1api~1v1~1patient-registry~1query/post/requestBody/content/application~1json/examples/example1"],"pointer":"/paths/~1api~1v1~1patient-registry~1query/post/requestBody","description":"The data required to create a new query."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/patient-registry/query","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateQueryDto","exampleIds":["paths/~1api~1v1~1patient-registry~1query/post/requestBody/content/application~1json/examples/example1"]}},"responseCodes":["201","400","401","403","429"],"pointer":"/api/v1/patient-registry/query","href":"query/publicquerycontroller_create","openApiOperationId":"PublicQueryController_create","summary":"Create Query"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"schemaId":"components/schemas/CreateQueryDto","exampleIds":["paths/~1api~1v1~1patient-registry~1query/post/requestBody/content/application~1json/examples/example1"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateQueryDto","exampleIds":["paths/~1api~1v1~1patient-registry~1query/post/requestBody/content/application~1json/examples/example1"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The query was successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryDto"}},"schemaId":"components/schemas/QueryDto"},{"code":"400","description":"Bad Request. The input data is invalid."},{"code":"401","description":"Unauthorized. The user is not authenticated."},{"code":"403","description":"Forbidden. The user does not have permission to create a query."},{"code":"429","description":"Too Many Requests. The user has exceeded the rate limit."}],"pointer":"/paths/~1api~1v1~1patient-registry~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/QueryDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/query/publicquerycontroller_create"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/query"},{"label":"Get Query","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/query/publicquerycontroller_get","routeSlug":"/apis/current/query/publicquerycontroller_get","metadata":{"seo":{"title":"Get Query","description":"Get a specific query by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicQueryController_get","name":"Get Query","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1query~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Query","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a specific query by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1query~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1query~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/query/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","404","429","default"],"pointer":"/api/v1/patient-registry/query/{id}","href":"query/publicquerycontroller_get","openApiOperationId":"PublicQueryController_get","summary":"Get Query"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"default","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetQueryResponse"}},"schemaId":"components/schemas/GetQueryResponse"}],"pointer":"/paths/~1api~1v1~1patient-registry~1query~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"default","schemaId":"components/schemas/GetQueryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetQueryResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/query/publicquerycontroller_get"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/query/{id}"}],"content":{"contentType":"group","meta":{"name":"Query"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A specified, approved request for patient records across the network (e.g., via Carequality/TEFCA to support treatment activities, via TEFCA for IAS queries) with an associated status (e.g., “completed”)."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/patient-registry/query","summary":"Search Queries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/query/publicquerycontroller_search","deprecated":false},{"title":"/api/v1/patient-registry/query","summary":"Create Query","prefix":{"name":"post","color":"post"},"badges":[],"link":"/query/publicquerycontroller_create","deprecated":false},{"title":"/api/v1/patient-registry/query/{id}","summary":"Get Query","prefix":{"name":"get","color":"get"},"badges":[],"link":"/query/publicquerycontroller_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Document","link":"/apis/current/document","routeSlug":"/apis/current/document","items":[{"label":"Create a Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/document/publicdocumentcontroller_create","routeSlug":"/apis/current/document/publicdocumentcontroller_create","metadata":{"seo":{"title":"Create a Document","description":"Create a new document for a subject and get a signed URL to upload the document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicDocumentController_create","name":"Create a Document","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1document/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new document for a subject and get a signed URL to upload the document."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1document/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDocumentRequest"}},"schemaId":"components/schemas/CreateDocumentRequest","pointer":"/paths/~1api~1v1~1patient-registry~1document/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/patient-registry/document","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateDocumentRequest"}},"responseCodes":["201","400","401","403","429"],"pointer":"/api/v1/patient-registry/document","href":"document/publicdocumentcontroller_create","openApiOperationId":"PublicDocumentController_create","summary":"Create a Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"schemaId":"components/schemas/CreateDocumentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDocumentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateDocumentResponse"}},"schemaId":"components/schemas/CreateDocumentResponse"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1document/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateDocumentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateDocumentResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document/publicdocumentcontroller_create"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/document"},{"label":"Search Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/document/publicdocumentcontroller_getall","routeSlug":"/apis/current/document/publicdocumentcontroller_getall","metadata":{"seo":{"title":"Search Documents","description":"Get a paginated list of documents for a subject."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicDocumentController_getAll","name":"Search Documents","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1document/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a paginated list of documents for a subject."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_49","description":"Field name to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_50","required":true},{"name":"informationTypes","in":"query","schemaId":"schema_40","description":"Document Classifications (an Array of strings)"}],"pointer":"/paths/~1api~1v1~1patient-registry~1document/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1document/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/document","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_49"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"},{"name":"informationTypes","in":"query","required":false,"schemaId":"schema_40"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/document","href":"document/publicdocumentcontroller_getall","openApiOperationId":"PublicDocumentController_getAll","summary":"Search Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentPaginationResult"}},"schemaId":"components/schemas/DocumentPaginationResult"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1document/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentPaginationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentPaginationResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document/publicdocumentcontroller_getall"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/document"},{"label":"Get Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/document/publicdocumentcontroller_getbyid","routeSlug":"/apis/current/document/publicdocumentcontroller_getbyid","metadata":{"seo":{"title":"Get Document","description":"Get a specific document by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicDocumentController_getById","name":"Get Document","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a specific document by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentId","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/document/{documentId}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"documentId","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/document/{documentId}","href":"document/publicdocumentcontroller_getbyid","openApiOperationId":"PublicDocumentController_getById","summary":"Get Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document/publicdocumentcontroller_getbyid"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/document/{documentId}"},{"label":"Update Document","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/document/publicdocumentcontroller_update","routeSlug":"/apis/current/document/publicdocumentcontroller_update","metadata":{"seo":{"title":"Update Document","description":"Update a document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicDocumentController_update","name":"Update Document","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a document."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentId","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDocumentRequest"}},"schemaId":"components/schemas/UpdateDocumentRequest","pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/patient-registry/document/{documentId}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"documentId","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateDocumentRequest"}},"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/document/{documentId}","href":"document/publicdocumentcontroller_update","openApiOperationId":"PublicDocumentController_update","summary":"Update Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"schemaId":"components/schemas/UpdateDocumentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDocumentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentSummary"}},"schemaId":"components/schemas/DocumentSummary"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentSummary","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentSummary"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document/publicdocumentcontroller_update"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/document/{documentId}"},{"label":"Publish Document","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/document/publicdocumentcontroller_reciprocity","routeSlug":"/apis/current/document/publicdocumentcontroller_reciprocity","metadata":{"seo":{"title":"Publish Document","description":"Publish a document for reciprocity to the EHR network. Can be used to update the template used for reciprocity as well. Note that the project's Reciprocity must be enabled and Requester Information and Encounter Information need to be properly set up in the Administration UI."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicDocumentController_reciprocity","name":"Publish Document","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}~1reciprocity/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Publish Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Publish a document for reciprocity to the EHR network. Can be used to update the template used for reciprocity as well. Note that the project's Reciprocity must be enabled and Requester Information and Encounter Information need to be properly set up in the Administration UI."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentId","in":"path","schemaId":"schema_46","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}~1reciprocity/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}~1reciprocity/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentReciprocityDto"}},"schemaId":"components/schemas/DocumentReciprocityDto","pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}~1reciprocity/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/patient-registry/document/{documentId}/reciprocity","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"documentId","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_46"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DocumentReciprocityDto"}},"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/document/{documentId}/reciprocity","href":"document/publicdocumentcontroller_reciprocity","openApiOperationId":"PublicDocumentController_reciprocity","summary":"Publish Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"schemaId":"components/schemas/DocumentReciprocityDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentReciprocityDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Empty body. Document published for reciprocity successfully."},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}~1reciprocity/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document/publicdocumentcontroller_reciprocity"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/document/{documentId}/reciprocity"},{"label":"Unpublish Document","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/document/publicdocumentcontroller_unpublish","routeSlug":"/apis/current/document/publicdocumentcontroller_unpublish","metadata":{"seo":{"title":"Unpublish Document","description":"Unpublish a document from reciprocity in the EHR network."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicDocumentController_unpublish","name":"Unpublish Document","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}~1reciprocity/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unpublish Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Unpublish a document from reciprocity in the EHR network."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentId","in":"path","schemaId":"schema_46","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}~1reciprocity/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}~1reciprocity/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/patient-registry/document/{documentId}/reciprocity","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"documentId","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_46"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/document/{documentId}/reciprocity","href":"document/publicdocumentcontroller_unpublish","openApiOperationId":"PublicDocumentController_unpublish","summary":"Unpublish Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Empty body. Document unpublished successfully."},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}~1reciprocity/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document/publicdocumentcontroller_unpublish"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/document/{documentId}/reciprocity"},{"label":"Get Document PDF URL","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/document/publicdocumentcontroller_getpdfbyid","routeSlug":"/apis/current/document/publicdocumentcontroller_getpdfbyid","metadata":{"seo":{"title":"Get Document PDF URL","description":"Get a signed URL to download the PDF version of a document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicDocumentController_getPdfById","name":"Get Document PDF URL","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}~1pdf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Document PDF URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a signed URL to download the PDF version of a document."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentId","in":"path","schemaId":"schema_46","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}~1pdf/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}~1pdf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/document/{documentId}/pdf","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"documentId","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_46"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/document/{documentId}/pdf","href":"document/publicdocumentcontroller_getpdfbyid","openApiOperationId":"PublicDocumentController_getPdfById","summary":"Get Document PDF URL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentPdfUrlDto"}},"schemaId":"components/schemas/DocumentPdfUrlDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1document~1{documentId}~1pdf/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentPdfUrlDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentPdfUrlDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document/publicdocumentcontroller_getpdfbyid"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/document/{documentId}/pdf"}],"content":{"contentType":"group","meta":{"name":"Document"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document","showPageActions":true},{"nodeType":"markdoc","content":"Patient records retrieved by the xCures platform and/or loaded by platform users."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/patient-registry/document","summary":"Create a Document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/document/publicdocumentcontroller_create","deprecated":false},{"title":"/api/v1/patient-registry/document","summary":"Search Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document/publicdocumentcontroller_getall","deprecated":false},{"title":"/api/v1/patient-registry/document/{documentId}","summary":"Get Document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document/publicdocumentcontroller_getbyid","deprecated":false},{"title":"/api/v1/patient-registry/document/{documentId}","summary":"Update Document","prefix":{"name":"put","color":"put"},"badges":[],"link":"/document/publicdocumentcontroller_update","deprecated":false},{"title":"/api/v1/patient-registry/document/{documentId}/reciprocity","summary":"Publish Document","prefix":{"name":"put","color":"put"},"badges":[],"link":"/document/publicdocumentcontroller_reciprocity","deprecated":false},{"title":"/api/v1/patient-registry/document/{documentId}/reciprocity","summary":"Unpublish Document","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/document/publicdocumentcontroller_unpublish","deprecated":false},{"title":"/api/v1/patient-registry/document/{documentId}/pdf","summary":"Get Document PDF URL","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document/publicdocumentcontroller_getpdfbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"FHIR","link":"/apis/current/fhir","routeSlug":"/apis/current/fhir","items":[{"label":"Allergy Intolerances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/fhir/publicfhircontroller_allergyintolerance","routeSlug":"/apis/current/fhir/publicfhircontroller_allergyintolerance","metadata":{"seo":{"title":"Allergy Intolerances","description":"Search the specific FHIR resources by subjectId. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicFhirController_allergyIntolerance","name":"Allergy Intolerances","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1allergyintolerance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Allergy Intolerances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the specific FHIR resources by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the latest documentation of the response, please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","required":true},{"name":"pageSize","in":"query","schemaId":"schema_34","required":true},{"name":"subjectId","in":"query","schemaId":"schema_50","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1allergyintolerance/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1allergyintolerance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/fhir/allergyintolerance","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_34"},{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/fhir/allergyintolerance","href":"fhir/publicfhircontroller_allergyintolerance","openApiOperationId":"PublicFhirController_allergyIntolerance","summary":"Allergy Intolerances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}],"headers":{"content-type":{"schema":{"type":"string","enum":["application/json+fhir"]}}},"headerSchemaId":"schema_52"}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1allergyintolerance/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fhir/publicfhircontroller_allergyintolerance"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/fhir/allergyintolerance"},{"label":"Basics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/fhir/publicfhircontroller_basic","routeSlug":"/apis/current/fhir/publicfhircontroller_basic","metadata":{"seo":{"title":"Basics","description":"Search the specific FHIR resources by subjectId. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicFhirController_basic","name":"Basics","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1basic/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Basics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the specific FHIR resources by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the latest documentation of the response, please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","required":true},{"name":"pageSize","in":"query","schemaId":"schema_34","required":true},{"name":"subjectId","in":"query","schemaId":"schema_50","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1basic/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1basic/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/fhir/basic","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_34"},{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/fhir/basic","href":"fhir/publicfhircontroller_basic","openApiOperationId":"PublicFhirController_basic","summary":"Basics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}],"headers":{"content-type":{"schema":{"type":"string","enum":["application/json+fhir"]}}},"headerSchemaId":"schema_52"}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1basic/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fhir/publicfhircontroller_basic"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/fhir/basic"},{"label":"Care Plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/fhir/publicfhircontroller_careplan","routeSlug":"/apis/current/fhir/publicfhircontroller_careplan","metadata":{"seo":{"title":"Care Plans","description":"Search the specific FHIR resources by subjectId. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicFhirController_carePlan","name":"Care Plans","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1careplan/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Care Plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the specific FHIR resources by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the latest documentation of the response, please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","required":true},{"name":"pageSize","in":"query","schemaId":"schema_34","required":true},{"name":"subjectId","in":"query","schemaId":"schema_50","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1careplan/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1careplan/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/fhir/careplan","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_34"},{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/fhir/careplan","href":"fhir/publicfhircontroller_careplan","openApiOperationId":"PublicFhirController_carePlan","summary":"Care Plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}],"headers":{"content-type":{"schema":{"type":"string","enum":["application/json+fhir"]}}},"headerSchemaId":"schema_52"}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1careplan/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fhir/publicfhircontroller_careplan"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/fhir/careplan"},{"label":"Coverages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/fhir/publicfhircontroller_coverage","routeSlug":"/apis/current/fhir/publicfhircontroller_coverage","metadata":{"seo":{"title":"Coverages","description":"Search the specific FHIR resources by subjectId. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicFhirController_coverage","name":"Coverages","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1coverage/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coverages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the specific FHIR resources by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the latest documentation of the response, please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","required":true},{"name":"pageSize","in":"query","schemaId":"schema_34","required":true},{"name":"subjectId","in":"query","schemaId":"schema_50","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1coverage/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1coverage/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/fhir/coverage","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_34"},{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/fhir/coverage","href":"fhir/publicfhircontroller_coverage","openApiOperationId":"PublicFhirController_coverage","summary":"Coverages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}],"headers":{"content-type":{"schema":{"type":"string","enum":["application/json+fhir"]}}},"headerSchemaId":"schema_52"}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1coverage/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fhir/publicfhircontroller_coverage"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/fhir/coverage"},{"label":"Conditions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/fhir/publicfhircontroller_condition","routeSlug":"/apis/current/fhir/publicfhircontroller_condition","metadata":{"seo":{"title":"Conditions","description":"Search the specific FHIR resources by subjectId. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicFhirController_condition","name":"Conditions","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1condition/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conditions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the specific FHIR resources by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the latest documentation of the response, please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","required":true},{"name":"pageSize","in":"query","schemaId":"schema_34","required":true},{"name":"subjectId","in":"query","schemaId":"schema_50","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1condition/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1condition/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/fhir/condition","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_34"},{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/fhir/condition","href":"fhir/publicfhircontroller_condition","openApiOperationId":"PublicFhirController_condition","summary":"Conditions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}],"headers":{"content-type":{"schema":{"type":"string","enum":["application/json+fhir"]}}},"headerSchemaId":"schema_52"}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1condition/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fhir/publicfhircontroller_condition"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/fhir/condition"},{"label":"Diagnostic Reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/fhir/publicfhircontroller_diagnosticreport","routeSlug":"/apis/current/fhir/publicfhircontroller_diagnosticreport","metadata":{"seo":{"title":"Diagnostic Reports","description":"Search the specific FHIR resources by subjectId. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicFhirController_diagnosticReport","name":"Diagnostic Reports","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1diagnosticreport/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Diagnostic Reports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the specific FHIR resources by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the latest documentation of the response, please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","required":true},{"name":"pageSize","in":"query","schemaId":"schema_34","required":true},{"name":"subjectId","in":"query","schemaId":"schema_50","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1diagnosticreport/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1diagnosticreport/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/fhir/diagnosticreport","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_34"},{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/fhir/diagnosticreport","href":"fhir/publicfhircontroller_diagnosticreport","openApiOperationId":"PublicFhirController_diagnosticReport","summary":"Diagnostic Reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}],"headers":{"content-type":{"schema":{"type":"string","enum":["application/json+fhir"]}}},"headerSchemaId":"schema_52"}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1diagnosticreport/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fhir/publicfhircontroller_diagnosticreport"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/fhir/diagnosticreport"},{"label":"Encounters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/fhir/publicfhircontroller_encounter","routeSlug":"/apis/current/fhir/publicfhircontroller_encounter","metadata":{"seo":{"title":"Encounters","description":"Search the specific FHIR resources by subjectId. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicFhirController_encounter","name":"Encounters","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1encounter/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Encounters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the specific FHIR resources by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the latest documentation of the response, please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","required":true},{"name":"pageSize","in":"query","schemaId":"schema_34","required":true},{"name":"subjectId","in":"query","schemaId":"schema_50","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1encounter/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1encounter/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/fhir/encounter","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_34"},{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/fhir/encounter","href":"fhir/publicfhircontroller_encounter","openApiOperationId":"PublicFhirController_encounter","summary":"Encounters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}],"headers":{"content-type":{"schema":{"type":"string","enum":["application/json+fhir"]}}},"headerSchemaId":"schema_52"}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1encounter/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fhir/publicfhircontroller_encounter"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/fhir/encounter"},{"label":"Medication Statements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/fhir/publicfhircontroller_medicationstatement","routeSlug":"/apis/current/fhir/publicfhircontroller_medicationstatement","metadata":{"seo":{"title":"Medication Statements","description":"Search the specific FHIR resources by subjectId. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicFhirController_medicationstatement","name":"Medication Statements","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1medicationstatement/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Medication Statements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the specific FHIR resources by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the latest documentation of the response, please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","required":true},{"name":"pageSize","in":"query","schemaId":"schema_34","required":true},{"name":"subjectId","in":"query","schemaId":"schema_50","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1medicationstatement/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1medicationstatement/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/fhir/medicationstatement","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_34"},{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/fhir/medicationstatement","href":"fhir/publicfhircontroller_medicationstatement","openApiOperationId":"PublicFhirController_medicationstatement","summary":"Medication Statements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}],"headers":{"content-type":{"schema":{"type":"string","enum":["application/json+fhir"]}}},"headerSchemaId":"schema_52"}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1medicationstatement/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fhir/publicfhircontroller_medicationstatement"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/fhir/medicationstatement"},{"label":"Patients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/fhir/publicfhircontroller_patient","routeSlug":"/apis/current/fhir/publicfhircontroller_patient","metadata":{"seo":{"title":"Patients","description":"Search the specific FHIR resources by subjectId. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicFhirController_patient","name":"Patients","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1patient/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the specific FHIR resources by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the latest documentation of the response, please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","required":true},{"name":"pageSize","in":"query","schemaId":"schema_34","required":true},{"name":"subjectId","in":"query","schemaId":"schema_50","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1patient/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1patient/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/fhir/patient","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_34"},{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/fhir/patient","href":"fhir/publicfhircontroller_patient","openApiOperationId":"PublicFhirController_patient","summary":"Patients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}],"headers":{"content-type":{"schema":{"type":"string","enum":["application/json+fhir"]}}},"headerSchemaId":"schema_52"}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1patient/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fhir/publicfhircontroller_patient"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/fhir/patient"},{"label":"Procedures","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/fhir/publicfhircontroller_procedure","routeSlug":"/apis/current/fhir/publicfhircontroller_procedure","metadata":{"seo":{"title":"Procedures","description":"Search the specific FHIR resources by subjectId. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicFhirController_procedure","name":"Procedures","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1procedure/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Procedures","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the specific FHIR resources by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the latest documentation of the response, please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","required":true},{"name":"pageSize","in":"query","schemaId":"schema_34","required":true},{"name":"subjectId","in":"query","schemaId":"schema_50","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1procedure/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1procedure/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/fhir/procedure","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_34"},{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/fhir/procedure","href":"fhir/publicfhircontroller_procedure","openApiOperationId":"PublicFhirController_procedure","summary":"Procedures"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}],"headers":{"content-type":{"schema":{"type":"string","enum":["application/json+fhir"]}}},"headerSchemaId":"schema_52"}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1procedure/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fhir/publicfhircontroller_procedure"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/fhir/procedure"},{"label":"Observations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/fhir/publicfhircontroller_observation","routeSlug":"/apis/current/fhir/publicfhircontroller_observation","metadata":{"seo":{"title":"Observations","description":"Search the specific FHIR resources by subjectId. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicFhirController_observation","name":"Observations","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1observation/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Observations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the specific FHIR resources by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the latest documentation of the response, please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","required":true},{"name":"pageSize","in":"query","schemaId":"schema_34","required":true},{"name":"subjectId","in":"query","schemaId":"schema_50","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1observation/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1observation/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/fhir/observation","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_34"},{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/fhir/observation","href":"fhir/publicfhircontroller_observation","openApiOperationId":"PublicFhirController_observation","summary":"Observations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}],"headers":{"content-type":{"schema":{"type":"string","enum":["application/json+fhir"]}}},"headerSchemaId":"schema_52"}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1observation/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fhir/publicfhircontroller_observation"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/fhir/observation"},{"label":"Specimens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/fhir/publicfhircontroller_specimen","routeSlug":"/apis/current/fhir/publicfhircontroller_specimen","metadata":{"seo":{"title":"Specimens","description":"Search the specific FHIR resources by subjectId. For the latest documentation of the response, please see the Resource Bundle definition in the FHIR spec."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicFhirController_specimen","name":"Specimens","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1specimen/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Specimens","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search the specific FHIR resources by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the latest documentation of the response, please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","required":true},{"name":"pageSize","in":"query","schemaId":"schema_34","required":true},{"name":"subjectId","in":"query","schemaId":"schema_50","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1specimen/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1specimen/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/fhir/specimen","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_34"},{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/fhir/specimen","href":"fhir/publicfhircontroller_specimen","openApiOperationId":"PublicFhirController_specimen","summary":"Specimens"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Bundle definition in the FHIR spec."},"children":[]}]}]}]}],"headers":{"content-type":{"schema":{"type":"string","enum":["application/json+fhir"]}}},"headerSchemaId":"schema_52"}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1specimen/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fhir/publicfhircontroller_specimen"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/fhir/specimen"},{"label":"Export FHIR Resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/fhir/publicfhircontroller_export","routeSlug":"/apis/current/fhir/publicfhircontroller_export","metadata":{"seo":{"title":"Export FHIR Resources","description":"Export a FHIR Bundle containing all of the subject's resources. The resulting FHIR Bundle will be in JSON Lines format."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicFhirController_export","name":"Export FHIR Resources","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1_export/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export FHIR Resources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export a FHIR Bundle containing all of the subject's resources. The resulting FHIR Bundle will be in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://jsonlines.org/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Lines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_50","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1_export/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1_export/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/fhir/_export","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"subjectId","in":"query","required":true,"schemaId":"schema_50"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["400","401","403","429","default"],"pointer":"/api/v1/patient-registry/fhir/_export","href":"fhir/publicfhircontroller_export","openApiOperationId":"PublicFhirController_export","summary":"Export FHIR Resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","description":"The result of the FHIR resource export.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FhirExportResponseDto"}},"schemaId":"components/schemas/FhirExportResponseDto","headers":{"content-type":{"schema":{"type":"string","enum":["application/json"]}},"expires":{"description":"Indicates when the resulting output URL(s) will expire.","schema":{"type":"string","example":"Wed, 21 Oct 2023 07:28:00 GMT"}}},"headerSchemaId":"schema_53"}],"pointer":"/paths/~1api~1v1~1patient-registry~1fhir~1_export/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"default","schemaId":"components/schemas/FhirExportResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FhirExportResponseDto"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fhir/publicfhircontroller_export"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/fhir/_export"}],"content":{"contentType":"group","meta":{"name":"FHIR"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FHIR","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ast "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"H"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ealthcare "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"I"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nteroperability "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"R"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"esource is an international data model specification developed by HL7 International to enable healthcare data exchange and interoperability between different systems."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/patient-registry/fhir/allergyintolerance","summary":"Allergy Intolerances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fhir/publicfhircontroller_allergyintolerance","deprecated":false},{"title":"/api/v1/patient-registry/fhir/basic","summary":"Basics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fhir/publicfhircontroller_basic","deprecated":false},{"title":"/api/v1/patient-registry/fhir/careplan","summary":"Care Plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fhir/publicfhircontroller_careplan","deprecated":false},{"title":"/api/v1/patient-registry/fhir/coverage","summary":"Coverages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fhir/publicfhircontroller_coverage","deprecated":false},{"title":"/api/v1/patient-registry/fhir/condition","summary":"Conditions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fhir/publicfhircontroller_condition","deprecated":false},{"title":"/api/v1/patient-registry/fhir/diagnosticreport","summary":"Diagnostic Reports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fhir/publicfhircontroller_diagnosticreport","deprecated":false},{"title":"/api/v1/patient-registry/fhir/encounter","summary":"Encounters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fhir/publicfhircontroller_encounter","deprecated":false},{"title":"/api/v1/patient-registry/fhir/medicationstatement","summary":"Medication Statements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fhir/publicfhircontroller_medicationstatement","deprecated":false},{"title":"/api/v1/patient-registry/fhir/patient","summary":"Patients","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fhir/publicfhircontroller_patient","deprecated":false},{"title":"/api/v1/patient-registry/fhir/procedure","summary":"Procedures","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fhir/publicfhircontroller_procedure","deprecated":false},{"title":"/api/v1/patient-registry/fhir/observation","summary":"Observations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fhir/publicfhircontroller_observation","deprecated":false},{"title":"/api/v1/patient-registry/fhir/specimen","summary":"Specimens","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fhir/publicfhircontroller_specimen","deprecated":false},{"title":"/api/v1/patient-registry/fhir/_export","summary":"Export FHIR Resources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fhir/publicfhircontroller_export","deprecated":false}]}]}]}]}},{"type":"group","label":"Clinical Concepts","link":"/apis/current/clinical-concepts","routeSlug":"/apis/current/clinical-concepts","items":[{"label":"Search Clinical Concepts Conditions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchconditions","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchconditions","metadata":{"seo":{"title":"Search Clinical Concepts Conditions","description":"Search for condition clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchConditions","name":"Search Clinical Concepts Conditions","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1condition/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Conditions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for condition clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1condition/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1condition/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/condition","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/condition","href":"clinical-concepts/publicclinicalconceptscontroller_searchconditions","openApiOperationId":"PublicClinicalConceptsController_searchConditions","summary":"Search Clinical Concepts Conditions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1condition/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchconditions"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/condition"},{"label":"Get Clinical Concept Condition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getcondition","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getcondition","metadata":{"seo":{"title":"Get Clinical Concept Condition","description":"Retrieve a specific condition clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getCondition","name":"Get Clinical Concept Condition","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1condition~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Condition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific condition clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1condition~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1condition~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1condition~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/condition/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/condition/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getcondition","openApiOperationId":"PublicClinicalConceptsController_getCondition","summary":"Get Clinical Concept Condition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptConditionDto"}},"schemaId":"components/schemas/ClinicalConceptConditionDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1condition~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptConditionDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptConditionDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getcondition"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/condition/{id}"},{"label":"Search Clinical Concepts Medications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchmedications","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchmedications","metadata":{"seo":{"title":"Search Clinical Concepts Medications","description":"Search for medication clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchMedications","name":"Search Clinical Concepts Medications","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1medication/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Medications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for medication clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1medication/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1medication/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/medication","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/medication","href":"clinical-concepts/publicclinicalconceptscontroller_searchmedications","openApiOperationId":"PublicClinicalConceptsController_searchMedications","summary":"Search Clinical Concepts Medications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1medication/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchmedications"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/medication"},{"label":"Get Clinical Concept Medication","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getmedication","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getmedication","metadata":{"seo":{"title":"Get Clinical Concept Medication","description":"Retrieve a specific medication clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getMedication","name":"Get Clinical Concept Medication","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1medication~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Medication","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific medication clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1medication~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1medication~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1medication~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/medication/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/medication/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getmedication","openApiOperationId":"PublicClinicalConceptsController_getMedication","summary":"Get Clinical Concept Medication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptMedicationDto"}},"schemaId":"components/schemas/ClinicalConceptMedicationDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1medication~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptMedicationDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptMedicationDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getmedication"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/medication/{id}"},{"label":"Search Clinical Concepts Allergies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchallergies","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchallergies","metadata":{"seo":{"title":"Search Clinical Concepts Allergies","description":"Search for allergy clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchAllergies","name":"Search Clinical Concepts Allergies","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1allergy/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Allergies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for allergy clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1allergy/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1allergy/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/allergy","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/allergy","href":"clinical-concepts/publicclinicalconceptscontroller_searchallergies","openApiOperationId":"PublicClinicalConceptsController_searchAllergies","summary":"Search Clinical Concepts Allergies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1allergy/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchallergies"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/allergy"},{"label":"Get Clinical Concept Allergy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getallergy","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getallergy","metadata":{"seo":{"title":"Get Clinical Concept Allergy","description":"Retrieve a specific allergy clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getAllergy","name":"Get Clinical Concept Allergy","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1allergy~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Allergy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific allergy clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1allergy~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1allergy~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1allergy~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/allergy/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/allergy/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getallergy","openApiOperationId":"PublicClinicalConceptsController_getAllergy","summary":"Get Clinical Concept Allergy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptAllergyDto"}},"schemaId":"components/schemas/ClinicalConceptAllergyDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1allergy~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptAllergyDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptAllergyDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getallergy"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/allergy/{id}"},{"label":"Search Clinical Concepts Procedures","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchprocedures","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchprocedures","metadata":{"seo":{"title":"Search Clinical Concepts Procedures","description":"Search for procedure clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchProcedures","name":"Search Clinical Concepts Procedures","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1procedure/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Procedures","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for procedure clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1procedure/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1procedure/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/procedure","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/procedure","href":"clinical-concepts/publicclinicalconceptscontroller_searchprocedures","openApiOperationId":"PublicClinicalConceptsController_searchProcedures","summary":"Search Clinical Concepts Procedures"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1procedure/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchprocedures"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/procedure"},{"label":"Get Clinical Concept Procedure","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getprocedure","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getprocedure","metadata":{"seo":{"title":"Get Clinical Concept Procedure","description":"Retrieve a specific procedure clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getProcedure","name":"Get Clinical Concept Procedure","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1procedure~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Procedure","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific procedure clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1procedure~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1procedure~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1procedure~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/procedure/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/procedure/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getprocedure","openApiOperationId":"PublicClinicalConceptsController_getProcedure","summary":"Get Clinical Concept Procedure"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptProcedureDto"}},"schemaId":"components/schemas/ClinicalConceptProcedureDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1procedure~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptProcedureDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptProcedureDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getprocedure"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/procedure/{id}"},{"label":"Search Clinical Concepts Biomarkers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchbiomarkers","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchbiomarkers","metadata":{"seo":{"title":"Search Clinical Concepts Biomarkers","description":"Search for biomarker clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchBiomarkers","name":"Search Clinical Concepts Biomarkers","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1biomarker/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Biomarkers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for biomarker clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1biomarker/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1biomarker/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/biomarker","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/biomarker","href":"clinical-concepts/publicclinicalconceptscontroller_searchbiomarkers","openApiOperationId":"PublicClinicalConceptsController_searchBiomarkers","summary":"Search Clinical Concepts Biomarkers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1biomarker/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchbiomarkers"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/biomarker"},{"label":"Get Clinical Concept Biomarker","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getbiomarker","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getbiomarker","metadata":{"seo":{"title":"Get Clinical Concept Biomarker","description":"Retrieve a specific biomarker clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getBiomarker","name":"Get Clinical Concept Biomarker","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1biomarker~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Biomarker","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific biomarker clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1biomarker~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1biomarker~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1biomarker~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/biomarker/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/biomarker/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getbiomarker","openApiOperationId":"PublicClinicalConceptsController_getBiomarker","summary":"Get Clinical Concept Biomarker"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptBiomarkerDto"}},"schemaId":"components/schemas/ClinicalConceptBiomarkerDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1biomarker~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptBiomarkerDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptBiomarkerDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getbiomarker"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/biomarker/{id}"},{"label":"Search Clinical Concepts Coverage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchcoverage","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchcoverage","metadata":{"seo":{"title":"Search Clinical Concepts Coverage","description":"Search for coverage clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchCoverage","name":"Search Clinical Concepts Coverage","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1coverage/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Coverage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for coverage clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1coverage/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1coverage/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/coverage","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/coverage","href":"clinical-concepts/publicclinicalconceptscontroller_searchcoverage","openApiOperationId":"PublicClinicalConceptsController_searchCoverage","summary":"Search Clinical Concepts Coverage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1coverage/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchcoverage"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/coverage"},{"label":"Get Clinical Concept Coverage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getcoverage","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getcoverage","metadata":{"seo":{"title":"Get Clinical Concept Coverage","description":"Retrieve a specific coverage clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getCoverage","name":"Get Clinical Concept Coverage","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1coverage~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Coverage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific coverage clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1coverage~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1coverage~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1coverage~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/coverage/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/coverage/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getcoverage","openApiOperationId":"PublicClinicalConceptsController_getCoverage","summary":"Get Clinical Concept Coverage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptCoverageDto"}},"schemaId":"components/schemas/ClinicalConceptCoverageDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1coverage~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptCoverageDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptCoverageDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getcoverage"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/coverage/{id}"},{"label":"Search Clinical Concepts Demographics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchdemographics","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchdemographics","metadata":{"seo":{"title":"Search Clinical Concepts Demographics","description":"Search for demographic clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchDemographics","name":"Search Clinical Concepts Demographics","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1demographic/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Demographics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for demographic clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1demographic/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1demographic/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/demographic","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/demographic","href":"clinical-concepts/publicclinicalconceptscontroller_searchdemographics","openApiOperationId":"PublicClinicalConceptsController_searchDemographics","summary":"Search Clinical Concepts Demographics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1demographic/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchdemographics"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/demographic"},{"label":"Get Clinical Concept Demographic","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getdemographic","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getdemographic","metadata":{"seo":{"title":"Get Clinical Concept Demographic","description":"Retrieve a specific demographic clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getDemographic","name":"Get Clinical Concept Demographic","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1demographic~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Demographic","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific demographic clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1demographic~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1demographic~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1demographic~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/demographic/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/demographic/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getdemographic","openApiOperationId":"PublicClinicalConceptsController_getDemographic","summary":"Get Clinical Concept Demographic"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptDemographicDto"}},"schemaId":"components/schemas/ClinicalConceptDemographicDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1demographic~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptDemographicDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptDemographicDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getdemographic"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/demographic/{id}"},{"label":"Search Clinical Concepts Encounters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchencounters","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchencounters","metadata":{"seo":{"title":"Search Clinical Concepts Encounters","description":"Search for encounter clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchEncounters","name":"Search Clinical Concepts Encounters","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1encounter/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Encounters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for encounter clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1encounter/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1encounter/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/encounter","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/encounter","href":"clinical-concepts/publicclinicalconceptscontroller_searchencounters","openApiOperationId":"PublicClinicalConceptsController_searchEncounters","summary":"Search Clinical Concepts Encounters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1encounter/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchencounters"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/encounter"},{"label":"Get Clinical Concept Encounter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getencounter","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getencounter","metadata":{"seo":{"title":"Get Clinical Concept Encounter","description":"Retrieve a specific encounter clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getEncounter","name":"Get Clinical Concept Encounter","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1encounter~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Encounter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific encounter clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1encounter~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1encounter~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1encounter~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/encounter/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/encounter/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getencounter","openApiOperationId":"PublicClinicalConceptsController_getEncounter","summary":"Get Clinical Concept Encounter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptEncounterDto"}},"schemaId":"components/schemas/ClinicalConceptEncounterDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1encounter~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptEncounterDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptEncounterDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getencounter"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/encounter/{id}"},{"label":"Search Clinical Concepts Family History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchfamilyhistory","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchfamilyhistory","metadata":{"seo":{"title":"Search Clinical Concepts Family History","description":"Search for family history clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchFamilyHistory","name":"Search Clinical Concepts Family History","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1family_history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Family History","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for family history clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1family_history/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1family_history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/family_history","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/family_history","href":"clinical-concepts/publicclinicalconceptscontroller_searchfamilyhistory","openApiOperationId":"PublicClinicalConceptsController_searchFamilyHistory","summary":"Search Clinical Concepts Family History"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1family_history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchfamilyhistory"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/family_history"},{"label":"Get Clinical Concept Family History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getfamilyhistory","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getfamilyhistory","metadata":{"seo":{"title":"Get Clinical Concept Family History","description":"Retrieve a specific family history clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getFamilyHistory","name":"Get Clinical Concept Family History","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1family_history~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Family History","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific family history clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1family_history~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1family_history~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1family_history~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/family_history/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/family_history/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getfamilyhistory","openApiOperationId":"PublicClinicalConceptsController_getFamilyHistory","summary":"Get Clinical Concept Family History"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptFamilyHistoryDto"}},"schemaId":"components/schemas/ClinicalConceptFamilyHistoryDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1family_history~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptFamilyHistoryDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptFamilyHistoryDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getfamilyhistory"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/family_history/{id}"},{"label":"Search Clinical Concepts Imaging","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchimaging","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchimaging","metadata":{"seo":{"title":"Search Clinical Concepts Imaging","description":"Search for imaging clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchImaging","name":"Search Clinical Concepts Imaging","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1imaging/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Imaging","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for imaging clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1imaging/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1imaging/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/imaging","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/imaging","href":"clinical-concepts/publicclinicalconceptscontroller_searchimaging","openApiOperationId":"PublicClinicalConceptsController_searchImaging","summary":"Search Clinical Concepts Imaging"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1imaging/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchimaging"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/imaging"},{"label":"Get Clinical Concept Imaging","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getimaging","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getimaging","metadata":{"seo":{"title":"Get Clinical Concept Imaging","description":"Retrieve a specific imaging clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getImaging","name":"Get Clinical Concept Imaging","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1imaging~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Imaging","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific imaging clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1imaging~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1imaging~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1imaging~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/imaging/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/imaging/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getimaging","openApiOperationId":"PublicClinicalConceptsController_getImaging","summary":"Get Clinical Concept Imaging"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptImagingDto"}},"schemaId":"components/schemas/ClinicalConceptImagingDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1imaging~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptImagingDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptImagingDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getimaging"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/imaging/{id}"},{"label":"Search Clinical Concepts Labs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchlabs","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchlabs","metadata":{"seo":{"title":"Search Clinical Concepts Labs","description":"Search for lab clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchLabs","name":"Search Clinical Concepts Labs","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1lab/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Labs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for lab clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1lab/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1lab/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/lab","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/lab","href":"clinical-concepts/publicclinicalconceptscontroller_searchlabs","openApiOperationId":"PublicClinicalConceptsController_searchLabs","summary":"Search Clinical Concepts Labs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1lab/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchlabs"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/lab"},{"label":"Get Clinical Concept Lab","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getlab","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getlab","metadata":{"seo":{"title":"Get Clinical Concept Lab","description":"Retrieve a specific lab clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getLab","name":"Get Clinical Concept Lab","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1lab~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Lab","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific lab clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1lab~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1lab~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1lab~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/lab/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/lab/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getlab","openApiOperationId":"PublicClinicalConceptsController_getLab","summary":"Get Clinical Concept Lab"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptLabDto"}},"schemaId":"components/schemas/ClinicalConceptLabDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1lab~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptLabDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptLabDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getlab"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/lab/{id}"},{"label":"Search Clinical Concepts Social History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchsocialhistory","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchsocialhistory","metadata":{"seo":{"title":"Search Clinical Concepts Social History","description":"Search for social history clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchSocialHistory","name":"Search Clinical Concepts Social History","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1social_history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Social History","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for social history clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1social_history/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1social_history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/social_history","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/social_history","href":"clinical-concepts/publicclinicalconceptscontroller_searchsocialhistory","openApiOperationId":"PublicClinicalConceptsController_searchSocialHistory","summary":"Search Clinical Concepts Social History"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1social_history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchsocialhistory"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/social_history"},{"label":"Get Clinical Concept Social History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getsocialhistory","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getsocialhistory","metadata":{"seo":{"title":"Get Clinical Concept Social History","description":"Retrieve a specific social history clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getSocialHistory","name":"Get Clinical Concept Social History","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1social_history~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Social History","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific social history clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1social_history~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1social_history~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1social_history~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/social_history/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/social_history/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getsocialhistory","openApiOperationId":"PublicClinicalConceptsController_getSocialHistory","summary":"Get Clinical Concept Social History"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptSocialHistoryDto"}},"schemaId":"components/schemas/ClinicalConceptSocialHistoryDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1social_history~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptSocialHistoryDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptSocialHistoryDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getsocialhistory"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/social_history/{id}"},{"label":"Search Clinical Concepts Surveys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchsurveys","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchsurveys","metadata":{"seo":{"title":"Search Clinical Concepts Surveys","description":"Search for survey clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchSurveys","name":"Search Clinical Concepts Surveys","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1survey/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Surveys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for survey clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1survey/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1survey/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/survey","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/survey","href":"clinical-concepts/publicclinicalconceptscontroller_searchsurveys","openApiOperationId":"PublicClinicalConceptsController_searchSurveys","summary":"Search Clinical Concepts Surveys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1survey/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchsurveys"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/survey"},{"label":"Get Clinical Concept Survey","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getsurvey","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getsurvey","metadata":{"seo":{"title":"Get Clinical Concept Survey","description":"Retrieve a specific survey clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getSurvey","name":"Get Clinical Concept Survey","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1survey~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Survey","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific survey clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1survey~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1survey~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1survey~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/survey/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/survey/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getsurvey","openApiOperationId":"PublicClinicalConceptsController_getSurvey","summary":"Get Clinical Concept Survey"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptSurveyDto"}},"schemaId":"components/schemas/ClinicalConceptSurveyDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1survey~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptSurveyDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptSurveyDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getsurvey"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/survey/{id}"},{"label":"Search Clinical Concepts Radiation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchradiation","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchradiation","metadata":{"seo":{"title":"Search Clinical Concepts Radiation","description":"Search for radiation clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchRadiation","name":"Search Clinical Concepts Radiation","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1radiation/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Radiation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for radiation clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1radiation/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1radiation/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/radiation","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/radiation","href":"clinical-concepts/publicclinicalconceptscontroller_searchradiation","openApiOperationId":"PublicClinicalConceptsController_searchRadiation","summary":"Search Clinical Concepts Radiation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1radiation/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchradiation"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/radiation"},{"label":"Get Clinical Concept Radiation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getradiation","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getradiation","metadata":{"seo":{"title":"Get Clinical Concept Radiation","description":"Retrieve a specific radiation clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getRadiation","name":"Get Clinical Concept Radiation","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1radiation~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Radiation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific radiation clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1radiation~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1radiation~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1radiation~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/radiation/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/radiation/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getradiation","openApiOperationId":"PublicClinicalConceptsController_getRadiation","summary":"Get Clinical Concept Radiation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptRadiationDto"}},"schemaId":"components/schemas/ClinicalConceptRadiationDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1radiation~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptRadiationDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptRadiationDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getradiation"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/radiation/{id}"},{"label":"Search Clinical Concepts Vitals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchvitals","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_searchvitals","metadata":{"seo":{"title":"Search Clinical Concepts Vitals","description":"Search for vital clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_searchVitals","name":"Search Clinical Concepts Vitals","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1vital/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Clinical Concepts Vitals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for vital clinical concepts associated with a specific subject. Supports filtering by search term, date range, code, and code system. Results are paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_33","description":"Page number to retrieve (1-based index)"},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Number of items per page"},{"name":"sortField","in":"query","schemaId":"schema_54","description":"Field to sort by"},{"name":"sortIsDescending","in":"query","schemaId":"schema_36","description":"Whether to sort in descending order"},{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true},{"name":"dateStart","in":"query","schemaId":"schema_56","description":"Start date for filtering (ISO string)"},{"name":"dateEnd","in":"query","schemaId":"schema_57","description":"End date for filtering (ISO string)"},{"name":"searchTerm","in":"query","schemaId":"schema_58","description":"Search term for filtering"},{"name":"searchTermMode","in":"query","schemaId":"schema_59","description":"Search mode: lexical (keyword), semantic (vector), or hybrid (RRF blend of both). Defaults to hybrid when a searchTerm is provided."},{"name":"code","in":"query","schemaId":"schema_60","description":"Filter by code value"},{"name":"codeSystem","in":"query","schemaId":"schema_61","description":"Filter by code system"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1vital/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1vital/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/vital","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_33"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_34"},{"name":"sortField","in":"query","required":false,"schemaId":"schema_54"},{"name":"sortIsDescending","in":"query","required":false,"schemaId":"schema_36"},{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"},{"name":"dateStart","in":"query","required":false,"example":"2025-01-01","schemaId":"schema_56"},{"name":"dateEnd","in":"query","required":false,"example":"2025-12-31","schemaId":"schema_57"},{"name":"searchTerm","in":"query","required":false,"example":"aspirin","schemaId":"schema_58"},{"name":"searchTermMode","in":"query","required":false,"schemaId":"schema_59"},{"name":"code","in":"query","required":false,"example":"E11.9","schemaId":"schema_60"},{"name":"codeSystem","in":"query","required":false,"example":"http://hl7.org/fhir/sid/icd-10","schemaId":"schema_61"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/vital","href":"clinical-concepts/publicclinicalconceptscontroller_searchvitals","openApiOperationId":"PublicClinicalConceptsController_searchVitals","summary":"Search Clinical Concepts Vitals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}},"schemaId":"components/schemas/PaginationResultDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1vital/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginationResultDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginationResultDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_searchvitals"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/vital"},{"label":"Get Clinical Concept Vital","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getvital","routeSlug":"/apis/current/clinical-concepts/publicclinicalconceptscontroller_getvital","metadata":{"seo":{"title":"Get Clinical Concept Vital","description":"Retrieve a specific vital clinical concept associated with a subject by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicClinicalConceptsController_getVital","name":"Get Clinical Concept Vital","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1vital~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinical Concept Vital","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific vital clinical concept associated with a subject by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1vital~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subjectId","in":"query","schemaId":"schema_55","description":"Subject ID (GUID)","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1vital~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1vital~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/clinical-concepts/vital/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[{"name":"subjectId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_55"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/api/v1/patient-registry/clinical-concepts/vital/{id}","href":"clinical-concepts/publicclinicalconceptscontroller_getvital","openApiOperationId":"PublicClinicalConceptsController_getVital","summary":"Get Clinical Concept Vital"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptVitalDto"}},"schemaId":"components/schemas/ClinicalConceptVitalDto"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1clinical-concepts~1vital~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalConceptVitalDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalConceptVitalDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinical-concepts/publicclinicalconceptscontroller_getvital"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/clinical-concepts/vital/{id}"}],"content":{"contentType":"group","meta":{"name":"Clinical Concepts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clinical Concepts","showPageActions":true},{"nodeType":"markdoc","content":"Clinical concepts is a proprietary xCures higher-level, flattened, filtered, opinionated view of medical record information, structured around FHIR guidelines."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/patient-registry/clinical-concepts/condition","summary":"Search Clinical Concepts Conditions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchconditions","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/condition/{id}","summary":"Get Clinical Concept Condition","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getcondition","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/medication","summary":"Search Clinical Concepts Medications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchmedications","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/medication/{id}","summary":"Get Clinical Concept Medication","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getmedication","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/allergy","summary":"Search Clinical Concepts Allergies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchallergies","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/allergy/{id}","summary":"Get Clinical Concept Allergy","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getallergy","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/procedure","summary":"Search Clinical Concepts Procedures","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchprocedures","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/procedure/{id}","summary":"Get Clinical Concept Procedure","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getprocedure","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/biomarker","summary":"Search Clinical Concepts Biomarkers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchbiomarkers","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/biomarker/{id}","summary":"Get Clinical Concept Biomarker","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getbiomarker","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/coverage","summary":"Search Clinical Concepts Coverage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchcoverage","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/coverage/{id}","summary":"Get Clinical Concept Coverage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getcoverage","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/demographic","summary":"Search Clinical Concepts Demographics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchdemographics","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/demographic/{id}","summary":"Get Clinical Concept Demographic","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getdemographic","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/encounter","summary":"Search Clinical Concepts Encounters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchencounters","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/encounter/{id}","summary":"Get Clinical Concept Encounter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getencounter","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/family_history","summary":"Search Clinical Concepts Family History","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchfamilyhistory","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/family_history/{id}","summary":"Get Clinical Concept Family History","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getfamilyhistory","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/imaging","summary":"Search Clinical Concepts Imaging","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchimaging","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/imaging/{id}","summary":"Get Clinical Concept Imaging","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getimaging","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/lab","summary":"Search Clinical Concepts Labs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchlabs","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/lab/{id}","summary":"Get Clinical Concept Lab","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getlab","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/social_history","summary":"Search Clinical Concepts Social History","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchsocialhistory","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/social_history/{id}","summary":"Get Clinical Concept Social History","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getsocialhistory","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/survey","summary":"Search Clinical Concepts Surveys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchsurveys","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/survey/{id}","summary":"Get Clinical Concept Survey","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getsurvey","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/radiation","summary":"Search Clinical Concepts Radiation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchradiation","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/radiation/{id}","summary":"Get Clinical Concept Radiation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getradiation","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/vital","summary":"Search Clinical Concepts Vitals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_searchvitals","deprecated":false},{"title":"/api/v1/patient-registry/clinical-concepts/vital/{id}","summary":"Get Clinical Concept Vital","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinical-concepts/publicclinicalconceptscontroller_getvital","deprecated":false}]}]}]}]}},{"type":"group","label":"Checklist","link":"/apis/current/checklist","routeSlug":"/apis/current/checklist","items":[{"label":"Get Checklists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/checklist/publicchecklistcontroller_list","routeSlug":"/apis/current/checklist/publicchecklistcontroller_list","metadata":{"seo":{"title":"Get Checklists","description":"Get the set of checklists configured for the project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicChecklistController_list","name":"Get Checklists","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1checklist/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Checklists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the set of checklists configured for the project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_62","description":"The type of checklist."}],"pointer":"/paths/~1api~1v1~1patient-registry~1checklist/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1checklist/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/checklist","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[{"name":"type","in":"query","required":false,"schemaId":"schema_62"}],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/checklist","href":"checklist/publicchecklistcontroller_list","openApiOperationId":"PublicChecklistController_list","summary":"Get Checklists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_63"}},"schemaId":"schema_63"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1checklist/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_63","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_63"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checklist/publicchecklistcontroller_list"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/checklist"},{"label":"Evaluate Checklist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/checklist/publicchecklistcontroller_evaluate","routeSlug":"/apis/current/checklist/publicchecklistcontroller_evaluate","metadata":{"seo":{"title":"Evaluate Checklist","description":"Evaluate a checklist for a subject."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicChecklistController_evaluate","name":"Evaluate Checklist","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1checklist~1{checklistId}~1evaluate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Evaluate Checklist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Evaluate a checklist for a subject."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"checklistId","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1checklist~1{checklistId}~1evaluate/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1checklist~1{checklistId}~1evaluate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChecklistEvaluationRequest"}},"schemaId":"components/schemas/ChecklistEvaluationRequest","pointer":"/paths/~1api~1v1~1patient-registry~1checklist~1{checklistId}~1evaluate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/patient-registry/checklist/{checklistId}/evaluate","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"checklistId","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChecklistEvaluationRequest"}},"responseCodes":["201","400","401","403","429"],"pointer":"/api/v1/patient-registry/checklist/{checklistId}/evaluate","href":"checklist/publicchecklistcontroller_evaluate","openApiOperationId":"PublicChecklistController_evaluate","summary":"Evaluate Checklist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"schemaId":"components/schemas/ChecklistEvaluationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChecklistEvaluationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChecklistEvaluationResult"}},"schemaId":"components/schemas/ChecklistEvaluationResult"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1checklist~1{checklistId}~1evaluate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ChecklistEvaluationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChecklistEvaluationResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checklist/publicchecklistcontroller_evaluate"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/checklist/{checklistId}/evaluate"},{"label":"Submit Checklist Item Feedback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/checklist/publicchecklistcontroller_submititemfeedback","routeSlug":"/apis/current/checklist/publicchecklistcontroller_submititemfeedback","metadata":{"seo":{"title":"Submit Checklist Item Feedback","description":"Submit feedback on a specific checklist item for a subject."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicChecklistController_submitItemFeedback","name":"Submit Checklist Item Feedback","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1checklist~1{checklistId}~1item~1{checklistItemId}~1feedback/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit Checklist Item Feedback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submit feedback on a specific checklist item for a subject."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"checklistId","in":"path","schemaId":"schema_38","required":true},{"name":"checklistItemId","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1checklist~1{checklistId}~1item~1{checklistItemId}~1feedback/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1checklist~1{checklistId}~1item~1{checklistItemId}~1feedback/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChecklistItemFeedbackRequest"}},"schemaId":"components/schemas/ChecklistItemFeedbackRequest","pointer":"/paths/~1api~1v1~1patient-registry~1checklist~1{checklistId}~1item~1{checklistItemId}~1feedback/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/patient-registry/checklist/{checklistId}/item/{checklistItemId}/feedback","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"checklistId","in":"path","required":true,"schemaId":"schema_38"},{"name":"checklistItemId","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChecklistItemFeedbackRequest"}},"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/checklist/{checklistId}/item/{checklistItemId}/feedback","href":"checklist/publicchecklistcontroller_submititemfeedback","openApiOperationId":"PublicChecklistController_submitItemFeedback","summary":"Submit Checklist Item Feedback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"schemaId":"components/schemas/ChecklistItemFeedbackRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChecklistItemFeedbackRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ID of the created feedback record.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1checklist~1{checklistId}~1item~1{checklistItemId}~1feedback/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checklist/publicchecklistcontroller_submititemfeedback"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/checklist/{checklistId}/item/{checklistItemId}/feedback"}],"content":{"contentType":"group","meta":{"name":"Checklist"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Checklist","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI-powered feature leveraging xCures’ targeted data extraction/processing to populate validated, customizable question/answer-style items. Responses can be highly flexible and every item returns a justification, supporting documents, and structured data to guide decisions in real time."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/patient-registry/checklist","summary":"Get Checklists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/checklist/publicchecklistcontroller_list","deprecated":false},{"title":"/api/v1/patient-registry/checklist/{checklistId}/evaluate","summary":"Evaluate Checklist","prefix":{"name":"post","color":"post"},"badges":[],"link":"/checklist/publicchecklistcontroller_evaluate","deprecated":false},{"title":"/api/v1/patient-registry/checklist/{checklistId}/item/{checklistItemId}/feedback","summary":"Submit Checklist Item Feedback","prefix":{"name":"post","color":"post"},"badges":[],"link":"/checklist/publicchecklistcontroller_submititemfeedback","deprecated":false}]}]}]}]}},{"type":"group","label":"Summary","link":"/apis/current/summary","routeSlug":"/apis/current/summary","items":[{"label":"Subject Summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/summary/publicsummarycontroller_subjectsummary","routeSlug":"/apis/current/summary/publicsummarycontroller_subjectsummary","metadata":{"seo":{"title":"Subject Summary","description":"Fetches the summary for a given subject. Throws a Forbidden error if the summary feature is disabled for the project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicSummaryController_subjectSummary","name":"Subject Summary","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1summary~1subject~1{subjectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subject Summary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches the summary for a given subject. Throws a Forbidden error if the summary feature is disabled for the project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subjectId","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1summary~1subject~1{subjectId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1summary~1subject~1{subjectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/summary/subject/{subjectId}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"subjectId","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/summary/subject/{subjectId}","href":"summary/publicsummarycontroller_subjectsummary","openApiOperationId":"PublicSummaryController_subjectSummary","summary":"Subject Summary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubjectSummaryDto"}},"schemaId":"components/schemas/SubjectSummaryDto"},{"code":"400"},{"code":"401"},{"code":"403","description":"Forbidden: The summary feature is not enabled for the project."},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1summary~1subject~1{subjectId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubjectSummaryDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubjectSummaryDto"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/summary/publicsummarycontroller_subjectsummary"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/summary/subject/{subjectId}"}],"content":{"contentType":"group","meta":{"name":"Summary"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Summary","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The AI-generated summary of a patient’s overall records and condition(s)."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/patient-registry/summary/subject/{subjectId}","summary":"Subject Summary","prefix":{"name":"get","color":"get"},"badges":[],"link":"/summary/publicsummarycontroller_subjectsummary","deprecated":false}]}]}]}]}},{"type":"group","label":"Application","link":"/apis/current/application","routeSlug":"/apis/current/application","items":[{"label":"Get Application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/application/publicapplicationcontroller_get","routeSlug":"/apis/current/application/publicapplicationcontroller_get","metadata":{"seo":{"title":"Get Application","description":"Get a specific application by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicApplicationController_get","name":"Get Application","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1application~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a specific application by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_50","description":"The ID of the application to retrieve.","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1application~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1application~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/application/{id}","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_50"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/application/{id}","href":"application/publicapplicationcontroller_get","openApiOperationId":"PublicApplicationController_get","summary":"Get Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Application"}},"schemaId":"components/schemas/Application"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1application~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Application","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Application"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application/publicapplicationcontroller_get"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/application/{id}"},{"label":"Create Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/application/publicapplicationcontroller_create","routeSlug":"/apis/current/application/publicapplicationcontroller_create","metadata":{"seo":{"title":"Create Application","description":"Create a new application. The application will be created in the system and an email will be sent to the applicant requesting consent."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicApplicationController_create","name":"Create Application","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1application/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new application. The application will be created in the system and an email will be sent to the applicant requesting consent."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1application/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateApplication"}},"schemaId":"components/schemas/CreateApplication","pointer":"/paths/~1api~1v1~1patient-registry~1application/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/patient-registry/application","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateApplication"}},"responseCodes":["201","400","401","403","429"],"pointer":"/api/v1/patient-registry/application","href":"application/publicapplicationcontroller_create","openApiOperationId":"PublicApplicationController_create","summary":"Create Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"schemaId":"components/schemas/CreateApplication","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateApplication"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateApplicationResponse"}},"schemaId":"components/schemas/CreateApplicationResponse"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1application/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateApplicationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateApplicationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application/publicapplicationcontroller_create"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/application"},{"label":"Resend Application Invite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/application/publicapplicationcontroller_resendverification","routeSlug":"/apis/current/application/publicapplicationcontroller_resendverification","metadata":{"seo":{"title":"Resend Application Invite","description":"Resends an email to the applicant requesting consent. Also updates the webhooks for the application."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicApplicationController_resendVerification","name":"Resend Application Invite","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1application~1{id}~1resend-verification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend Application Invite","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resends an email to the applicant requesting consent. Also updates the webhooks for the application."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_38","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1application~1{id}~1resend-verification/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1application~1{id}~1resend-verification/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationWebhooks"}},"schemaId":"components/schemas/ApplicationWebhooks","pointer":"/paths/~1api~1v1~1patient-registry~1application~1{id}~1resend-verification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/patient-registry/application/{id}/resend-verification","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_38"}],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationWebhooks"}},"responseCodes":["201","400","401","403","429"],"pointer":"/api/v1/patient-registry/application/{id}/resend-verification","href":"application/publicapplicationcontroller_resendverification","openApiOperationId":"PublicApplicationController_resendVerification","summary":"Resend Application Invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"schemaId":"components/schemas/ApplicationWebhooks","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationWebhooks"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1application~1{id}~1resend-verification/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application/publicapplicationcontroller_resendverification"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/application/{id}/resend-verification"}],"content":{"contentType":"group","meta":{"name":"Application"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Application","showPageActions":true},{"nodeType":"markdoc","content":"Account creation (e.g., identity proofing, eConsent) that is required for a patient to progress on the xCures Platform."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/patient-registry/application/{id}","summary":"Get Application","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application/publicapplicationcontroller_get","deprecated":false},{"title":"/api/v1/patient-registry/application","summary":"Create Application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application/publicapplicationcontroller_create","deprecated":false},{"title":"/api/v1/patient-registry/application/{id}/resend-verification","summary":"Resend Application Invite","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application/publicapplicationcontroller_resendverification","deprecated":false}]}]}]}]}},{"type":"group","label":"Reciprocity Template","link":"/apis/current/reciprocity-template","routeSlug":"/apis/current/reciprocity-template","items":[{"label":"List Reciprocity Templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/reciprocity-template/publicreciprocitytemplatecontroller_list","routeSlug":"/apis/current/reciprocity-template/publicreciprocitytemplatecontroller_list","metadata":{"seo":{"title":"List Reciprocity Templates","description":"Get a list of all reciprocity document templates available under this project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicReciprocityTemplateController_list","name":"List Reciprocity Templates","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1reciprocity-template/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Reciprocity Templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of all reciprocity document templates available under this project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"ProjectId","in":"header","schemaId":"schema_42","required":true}],"pointer":"/paths/~1api~1v1~1patient-registry~1reciprocity-template/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/reciprocity-template","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"ProjectId","in":"header","required":true,"example":"e6b01018-a333-4732-917e-fe38e91b0fdf","schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/reciprocity-template","href":"reciprocity-template/publicreciprocitytemplatecontroller_list","openApiOperationId":"PublicReciprocityTemplateController_list","summary":"List Reciprocity Templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64"}},"schemaId":"schema_64"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1reciprocity-template/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_64","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reciprocity-template/publicreciprocitytemplatecontroller_list"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/reciprocity-template"}],"content":{"contentType":"group","meta":{"name":"Reciprocity Template"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reciprocity Template","showPageActions":true},{"nodeType":"markdoc","content":"Reciprocity or \"Responder\" workflows refer to the process of sharing clinical documentation housed within your system with other organizations/providers, when participating in health data exchange networks (e.g., Carequality, TEFCA)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/patient-registry/reciprocity-template","summary":"List Reciprocity Templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reciprocity-template/publicreciprocitytemplatecontroller_list","deprecated":false}]}]}]}]}},{"type":"group","label":"Project","link":"/apis/current/project","routeSlug":"/apis/current/project","items":[{"label":"List Projects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/current/project/publicprojectcontroller_getall","routeSlug":"/apis/current/project/publicprojectcontroller_getall","metadata":{"seo":{"title":"List Projects","description":"Returns the projects your credentials can access, including each projectId. No ProjectId header is required — use this to discover the projectId values needed for other API calls."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PublicProjectController_getAll","name":"List Projects","isWebhook":false,"pointer":"/paths/~1api~1v1~1patient-registry~1project/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Projects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the projects your credentials can access, including each projectId. No ProjectId header is required — use this to discover the projectId values needed for other API calls."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/patient-registry/project","servers":[{"url":"https://partner.xcures.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/patient-registry/project","href":"project/publicprojectcontroller_getall","openApiOperationId":"PublicProjectController_getAll","summary":"List Projects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partner.xcures.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}},"schemaId":"schema_65"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"pointer":"/paths/~1api~1v1~1patient-registry~1project/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_65","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/publicprojectcontroller_getall"}],"panels":[]}]},"httpPath":"/api/v1/patient-registry/project"}],"content":{"contentType":"group","meta":{"name":"Project"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project","showPageActions":true},{"nodeType":"markdoc","content":"A configured workspace on the xCures Platform. Use this endpoint to discover the projectId value(s) required by other API calls, without needing to log into the portal."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/patient-registry/project","summary":"List Projects","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project/publicprojectcontroller_getall","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/OAuthTokenRequestDto":{"id":"components/schemas/OAuthTokenRequestDto","kind":"json-schema","title":"OAuthTokenRequestDto","data":{"type":"object","properties":{"client_id":{"type":"string","format":"uuid","example":"c8ec1d54-a85c-411f-aa12-fd3a7f2480f4","description":"Your API key's client ID."},"client_secret":{"type":"string","description":"Your API key's client secret."},"grant_type":{"type":"string","example":"client_credentials","enum":["client_credentials"],"description":"The OAuth 2.0 grant type."}},"required":["client_id","client_secret","grant_type"]}},"components/schemas/OAuthTokenResponseDto":{"id":"components/schemas/OAuthTokenResponseDto","kind":"json-schema","title":"OAuthTokenResponseDto","data":{"type":"object","properties":{"access_token":{"type":"string","description":"The credential used to authenticate API requests."},"token_type":{"type":"string","example":"Bearer","description":"The type of token being issued."}},"required":["access_token","token_type"]}},"components/schemas/Application":{"id":"components/schemas/Application","kind":"json-schema","title":"Application","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"c8ec1d54-a85c-411f-aa12-fd3a7f2480f4"},"created":{"format":"ISO 8601","type":"string","example":"2025-05-26T23:30:40.912Z","readOnly":true},"updated":{"format":"ISO 8601","type":"string","example":"2025-05-26T23:30:40.912Z","readOnly":true},"firstName":{"type":"string","example":"David"},"middleName":{"type":"string","example":"Quincy","description":"Full middle name or a bare initial; omit if the applicant has none."},"lastName":{"type":"string","example":"Mann"},"birthDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"},"addressLine1":{"type":"string","example":"123 Main St."},"addressLine2":{"type":"string","example":"Apt 4B"},"addressCity":{"type":"string","example":"Minneapolis"},"addressState":{"type":"string","format":"XX","example":"MN","description":"Two letter state code"},"addressPostalCode":{"type":"string","maxLength":10,"example":"55401"},"sexAtBirth":{"type":"string","enum":["male","female","unknown"]},"emailAddress":{"type":"string","format":"email","example":"david.mann@example.com"},"phoneNumber":{"type":"string","example":"123-456-7890"},"cohortId":{"type":"string","format":"uuid","example":"f46c52af-820b-4169-82af-b740b54d8bb5"},"cohortName":{"type":"string","example":"Cohort A"},"subjectId":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"consentAccepted":{"type":"boolean"},"onConsentWebhookUrl":{"type":"string","description":"Webhook URL to invoke when an applicant accepts or denies consent.","example":"https://example.com/webhooks/consent"},"onIdentityValidationWebhookUrl":{"type":"string","description":"Webhook URL to invoke when there's a result for an applicant's identity validation.","example":"https://example.com/webhooks/identity-validation"},"onQueryResultWebhookUrl":{"type":"string","description":"Webhook URL to invoke when there's a result for an applicant's EHR query.","example":"https://example.com/webhooks/ehr-query"}},"required":["id","created","updated","firstName","lastName","birthDate","addressPostalCode","sexAtBirth","emailAddress"]}},"components/schemas/CreateApplication":{"id":"components/schemas/CreateApplication","kind":"json-schema","title":"CreateApplication","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"c8ec1d54-a85c-411f-aa12-fd3a7f2480f4"},"firstName":{"type":"string","example":"David"},"middleName":{"type":"string","example":"Quincy","description":"Full middle name or a bare initial; omit if the applicant has none."},"lastName":{"type":"string","example":"Mann"},"birthDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"},"addressLine1":{"type":"string","example":"123 Main St."},"addressLine2":{"type":"string","example":"Apt 4B"},"addressCity":{"type":"string","example":"Minneapolis"},"addressState":{"type":"string","format":"XX","example":"MN","description":"Two letter state code"},"addressPostalCode":{"type":"string","maxLength":10,"example":"55401"},"sexAtBirth":{"type":"string","enum":["male","female","unknown"]},"emailAddress":{"type":"string","format":"email","example":"david.mann@example.com"},"phoneNumber":{"type":"string","example":"123-456-7890"},"cohortId":{"type":"string","format":"uuid","example":"f46c52af-820b-4169-82af-b740b54d8bb5"},"onConsentWebhookUrl":{"type":"string","description":"Webhook URL to invoke when an applicant accepts or denies consent.","example":"https://example.com/webhooks/consent"},"onIdentityValidationWebhookUrl":{"type":"string","description":"Webhook URL to invoke when there's a result for an applicant's identity validation.","example":"https://example.com/webhooks/identity-validation"},"onQueryResultWebhookUrl":{"type":"string","description":"Webhook URL to invoke when there's a result for an applicant's EHR query.","example":"https://example.com/webhooks/ehr-query"}},"required":["id","firstName","lastName","birthDate","addressPostalCode","sexAtBirth","emailAddress"]}},"components/schemas/CreateApplicationResponse":{"id":"components/schemas/CreateApplicationResponse","kind":"json-schema","title":"CreateApplicationResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"c8ec1d54-a85c-411f-aa12-fd3a7f2480f4"},"created":{"format":"ISO 8601","type":"string","example":"2025-05-26T23:30:40.912Z","readOnly":true},"updated":{"format":"ISO 8601","type":"string","example":"2025-05-26T23:30:40.912Z","readOnly":true},"firstName":{"type":"string","example":"David"},"middleName":{"type":"string","example":"Quincy","description":"Full middle name or a bare initial; omit if the applicant has none."},"lastName":{"type":"string","example":"Mann"},"birthDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"},"addressLine1":{"type":"string","example":"123 Main St."},"addressLine2":{"type":"string","example":"Apt 4B"},"addressCity":{"type":"string","example":"Minneapolis"},"addressState":{"type":"string","format":"XX","example":"MN","description":"Two letter state code"},"addressPostalCode":{"type":"string","maxLength":10,"example":"55401"},"sexAtBirth":{"type":"string","enum":["male","female","unknown"]},"emailAddress":{"type":"string","format":"email","example":"david.mann@example.com"},"phoneNumber":{"type":"string","example":"123-456-7890"},"cohortId":{"type":"string","format":"uuid","example":"f46c52af-820b-4169-82af-b740b54d8bb5"},"cohortName":{"type":"string","example":"Cohort A"},"consentAccepted":{"type":"boolean"},"onConsentWebhookUrl":{"type":"string","description":"Webhook URL to invoke when an applicant accepts or denies consent.","example":"https://example.com/webhooks/consent"},"onIdentityValidationWebhookUrl":{"type":"string","description":"Webhook URL to invoke when there's a result for an applicant's identity validation.","example":"https://example.com/webhooks/identity-validation"},"onQueryResultWebhookUrl":{"type":"string","description":"Webhook URL to invoke when there's a result for an applicant's EHR query.","example":"https://example.com/webhooks/ehr-query"}},"required":["id","created","updated","firstName","lastName","birthDate","addressPostalCode","sexAtBirth","emailAddress"]}},"components/schemas/ApplicationWebhooks":{"id":"components/schemas/ApplicationWebhooks","kind":"json-schema","title":"ApplicationWebhooks","data":{"type":"object","properties":{"onConsentWebhookUrl":{"type":"string"},"onIdentityValidationWebhookUrl":{"type":"string"},"onQueryResultWebhookUrl":{"type":"string"}}}},"components/schemas/SubjectExternalIdentifier":{"id":"components/schemas/SubjectExternalIdentifier","kind":"json-schema","title":"SubjectExternalIdentifier","data":{"type":"object","properties":{"externalIdentifier":{"type":"string"},"externalSystem":{"type":"string"}},"required":["externalIdentifier","externalSystem"]}},"components/schemas/SubjectAdditionalName":{"id":"components/schemas/SubjectAdditionalName","kind":"json-schema","title":"SubjectAdditionalName","data":{"type":"object","properties":{"first":{"type":"string","description":"At least one of 'first' and 'last' must be provided."},"last":{"type":"string","description":"At least one of 'first' and 'last' must be provided."},"middle":{"type":"string","description":"Full middle name or a bare initial for this alternate name; omit if unknown."}}}},"components/schemas/SubjectAddressDto":{"id":"components/schemas/SubjectAddressDto","kind":"json-schema","title":"SubjectAddressDto","data":{"type":"object","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressCity":{"type":"string"},"addressState":{"type":"string"},"addressPostalCode":{"type":"string"}}}},"components/schemas/SubjectTagDto":{"id":"components/schemas/SubjectTagDto","kind":"json-schema","title":"SubjectTagDto","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Caller-supplied UUID for the tag value. Required on create: the column is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with no database default and no server-side generation."},"children":[]}]}]}]},"projectTagId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ProjectTag being valued. Its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" decides which of the four value fields below is required."},"children":[]}]}]}]},"valueText":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value when the referenced ProjectTag has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and required in that case. Absent otherwise."},"children":[]}]}]}]},"valueNumber":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value when the referenced ProjectTag has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and required in that case. Absent otherwise."},"children":[]}]}]}]},"valueDate":{"format":"date-time","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value when the referenced ProjectTag has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and required in that case. Absent otherwise."},"children":[]}]}]}]},"valueBoolean":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value when the referenced ProjectTag has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"boolean"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and required in that case. Absent otherwise."},"children":[]}]}]}]},"subjectId":{"type":"string","readOnly":true,"format":"uuid","description":"Subject the tag belongs to. Assigned from the subject being created or updated; anything sent is ignored."},"organizationId":{"type":"string","readOnly":true,"format":"uuid","description":"Assigned from the authenticated organization; anything sent is ignored."},"projectId":{"type":"string","readOnly":true,"format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigned from the request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; anything sent is ignored."},"children":[]}]}]}]},"created":{"format":"date-time","type":"string","readOnly":true,"description":"Assigned server-side on create; anything sent is ignored."},"updated":{"format":"date-time","type":"string","readOnly":true,"description":"Assigned server-side on create and update; anything sent is ignored."}},"required":["id","projectTagId"]}},"components/schemas/Subject":{"id":"components/schemas/Subject","kind":"json-schema","title":"Subject","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"created":{"format":"ISO 8601","type":"string","example":"2025-05-26T23:30:40.912Z","readOnly":true},"updated":{"format":"ISO 8601","type":"string","example":"2025-05-26T23:30:40.912Z","readOnly":true},"deleted":{"format":"ISO 8601","type":"string","example":"2025-05-26T23:30:40.912Z","readOnly":true},"identifier":{"type":"string","example":"ABCD12","description":"A human-readable, randomly generated, 6 character alpha-numeric identifier for the subject.","readOnly":true},"firstName":{"type":"string","example":"David"},"middleName":{"type":"string","example":"Quincy","description":"Full middle name or a bare initial; omit if the subject has none. An update that omits this field clears any stored value."},"lastName":{"type":"string","example":"Mann"},"email":{"type":"string","format":"email","example":"david.mann@example.com"},"birthDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"},"deathDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"},"gender":{"type":"string","enum":["M","F",null],"example":"M","description":"For guaranteed long term compatibility we recommend using the single character gender identifiers. We will optimistically accept other formats like 'male' and 'female'."},"addressLine1":{"type":"string","example":"123 Main St."},"addressLine2":{"type":"string","example":"Apt 4B"},"addressCity":{"type":"string","example":"Minneapolis"},"addressState":{"type":"string","format":"XX","example":"MN","description":"Two letter state code"},"addressPostalCode":{"type":"string","format":"00000","example":"55401","description":"5 or 9 digit postal code"},"phoneNumber":{"type":"string","example":"123-456-7890"},"externalIdentifiers":{"example":[{"externalIdentifier":"12345","externalSystem":"Hospital A"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectExternalIdentifier"}},"labels":{"example":["label_1","Label 2"],"type":"array","items":{"type":"string"}},"cohortNames":{"type":"array","items":{"type":"string"}},"additionalNames":{"example":[{"first":"Dave","last":"Mann"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectAdditionalName"}},"additionalAddresses":{"example":[{"addressLine1":"456 Other St.","addressCity":"Saint Paul","addressState":"MN","addressPostalCode":"55101"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectAddressDto"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/SubjectTagDto"}}},"required":["id","created","updated","identifier","firstName","lastName"]}},"components/schemas/SubjectPaginationResult":{"id":"components/schemas/SubjectPaginationResult","kind":"json-schema","title":"SubjectPaginationResult","data":{"type":"object","properties":{"pageNumber":{"type":"number","default":1,"description":"Page number to retrieve (1-based index)"},"pageSize":{"type":"number","default":50,"description":"Number of items per page"},"sortField":{"type":"string","default":"created","description":"Field name to sort by"},"sortIsDescending":{"type":"boolean","default":false,"description":"Whether to sort in descending order"},"totalCount":{"type":"number","description":"Total number of items matching the query"},"results":{"description":"List of results for the current page","type":"array","items":{"$ref":"#/components/schemas/Subject"}}},"required":["totalCount","results"]}},"components/schemas/CreateSubject":{"id":"components/schemas/CreateSubject","kind":"json-schema","title":"CreateSubject","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"firstName":{"type":"string","example":"David"},"middleName":{"type":"string","example":"Quincy","description":"Full middle name or a bare initial; omit if the subject has none. An update that omits this field clears any stored value."},"lastName":{"type":"string","example":"Mann"},"email":{"type":"string","format":"email","example":"david.mann@example.com"},"birthDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"},"deathDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"},"gender":{"type":"string","enum":["M","F",null],"example":"M","description":"For guaranteed long term compatibility we recommend using the single character gender identifiers. We will optimistically accept other formats like 'male' and 'female'."},"addressLine1":{"type":"string","example":"123 Main St."},"addressLine2":{"type":"string","example":"Apt 4B"},"addressCity":{"type":"string","example":"Minneapolis"},"addressState":{"type":"string","format":"XX","example":"MN","description":"Two letter state code"},"addressPostalCode":{"type":"string","format":"00000","example":"55401","description":"5 or 9 digit postal code"},"phoneNumber":{"type":"string","example":"123-456-7890"},"externalIdentifiers":{"example":[{"externalIdentifier":"12345","externalSystem":"Hospital A"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectExternalIdentifier"}},"labels":{"example":["label_1","Label 2"],"type":"array","items":{"type":"string"}},"additionalNames":{"example":[{"first":"Dave","last":"Mann"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectAdditionalName"}},"additionalAddresses":{"example":[{"addressLine1":"456 Other St.","addressCity":"Saint Paul","addressState":"MN","addressPostalCode":"55101"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectAddressDto"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/SubjectTagDto"}}},"required":["id","firstName","lastName"]}},"components/schemas/CreateSubjectBatchOptions":{"id":"components/schemas/CreateSubjectBatchOptions","kind":"json-schema","title":"CreateSubjectBatchOptions","data":{"type":"object","properties":{"initiateEhrQueries":{"type":"boolean","description":"When true, initiates EHR queries for all subjects in the batch after creation. Defaults to true when omitted.","default":true}}}},"components/schemas/CreateSubjectBatch":{"id":"components/schemas/CreateSubjectBatch","kind":"json-schema","title":"CreateSubjectBatch","data":{"type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/components/schemas/CreateSubject"}},"options":{"$ref":"#/components/schemas/CreateSubjectBatchOptions"}},"required":["subjects"]}},"components/schemas/CreateSubjectResult":{"id":"components/schemas/CreateSubjectResult","kind":"json-schema","title":"CreateSubjectResult","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"created":{"format":"ISO 8601","type":"string","example":"2025-05-26T23:30:40.912Z","readOnly":true},"updated":{"format":"ISO 8601","type":"string","example":"2025-05-26T23:30:40.912Z","readOnly":true},"deleted":{"format":"ISO 8601","type":"string","example":"2025-05-26T23:30:40.912Z","readOnly":true},"identifier":{"type":"string","example":"ABCD12","description":"A human-readable, randomly generated, 6 character alpha-numeric identifier for the subject.","readOnly":true},"firstName":{"type":"string","example":"David"},"middleName":{"type":"string","example":"Quincy","description":"Full middle name or a bare initial; omit if the subject has none. An update that omits this field clears any stored value."},"lastName":{"type":"string","example":"Mann"},"email":{"type":"string","format":"email","example":"david.mann@example.com"},"birthDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"},"deathDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"},"gender":{"type":"string","enum":["M","F",null],"example":"M","description":"For guaranteed long term compatibility we recommend using the single character gender identifiers. We will optimistically accept other formats like 'male' and 'female'."},"addressLine1":{"type":"string","example":"123 Main St."},"addressLine2":{"type":"string","example":"Apt 4B"},"addressCity":{"type":"string","example":"Minneapolis"},"addressState":{"type":"string","format":"XX","example":"MN","description":"Two letter state code"},"addressPostalCode":{"type":"string","format":"00000","example":"55401","description":"5 or 9 digit postal code"},"phoneNumber":{"type":"string","example":"123-456-7890"},"externalIdentifiers":{"example":[{"externalIdentifier":"12345","externalSystem":"Hospital A"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectExternalIdentifier"}},"labels":{"example":["label_1","Label 2"],"type":"array","items":{"type":"string"}},"cohortNames":{"type":"array","items":{"type":"string"}},"additionalNames":{"example":[{"first":"Dave","last":"Mann"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectAdditionalName"}},"additionalAddresses":{"example":[{"addressLine1":"456 Other St.","addressCity":"Saint Paul","addressState":"MN","addressPostalCode":"55101"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectAddressDto"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/SubjectTagDto"}},"failureReason":{"type":"string"}},"required":["id","created","updated","identifier","firstName","lastName"]}},"components/schemas/UpdateSubject":{"id":"components/schemas/UpdateSubject","kind":"json-schema","title":"UpdateSubject","data":{"type":"object","properties":{"firstName":{"type":"string","example":"David"},"middleName":{"type":"string","example":"Quincy","description":"Full middle name or a bare initial; omit if the subject has none. An update that omits this field clears any stored value."},"lastName":{"type":"string","example":"Mann"},"email":{"type":"string","format":"email","example":"david.mann@example.com"},"birthDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"},"deathDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"},"gender":{"type":"string","enum":["M","F",null],"example":"M","description":"For guaranteed long term compatibility we recommend using the single character gender identifiers. We will optimistically accept other formats like 'male' and 'female'."},"addressLine1":{"type":"string","example":"123 Main St."},"addressLine2":{"type":"string","example":"Apt 4B"},"addressCity":{"type":"string","example":"Minneapolis"},"addressState":{"type":"string","format":"XX","example":"MN","description":"Two letter state code"},"addressPostalCode":{"type":"string","format":"00000","example":"55401","description":"5 or 9 digit postal code"},"phoneNumber":{"type":"string","example":"123-456-7890"},"externalIdentifiers":{"example":[{"externalIdentifier":"12345","externalSystem":"Hospital A"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectExternalIdentifier"}},"labels":{"example":["label_1","Label 2"],"type":"array","items":{"type":"string"}},"additionalNames":{"example":[{"first":"Dave","last":"Mann"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectAdditionalName"}},"additionalAddresses":{"example":[{"addressLine1":"456 Other St.","addressCity":"Saint Paul","addressState":"MN","addressPostalCode":"55101"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectAddressDto"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/SubjectTagDto"}}},"required":["firstName","lastName"]}},"components/schemas/ClinicalConceptsStatusDto":{"id":"components/schemas/ClinicalConceptsStatusDto","kind":"json-schema","title":"ClinicalConceptsStatusDto","data":{"type":"object","properties":{"loaded":{"type":"boolean"},"timestamp":{"format":"date-time","type":"string"}},"required":["loaded"]}},"components/schemas/QueryAttempt":{"id":"components/schemas/QueryAttempt","kind":"json-schema","title":"QueryAttempt","data":{"type":"object","properties":{"queryId":{"type":"string"},"created":{"format":"date-time","type":"string"},"fhirResult":{"type":"string","enum":["delayed","initiated","pending","inProgress","completed","exhausted","error"]},"ccdaResult":{"type":"string","enum":["delayed","initiated","pending","inProgress","completed","exhausted","error"]},"message":{"type":"string"}},"required":["queryId","created"]}},"components/schemas/Query":{"id":"components/schemas/Query","kind":"json-schema","title":"Query","data":{"type":"object","properties":{"id":{"type":"string"},"subjectId":{"type":"string"},"created":{"format":"date-time","type":"string"},"userId":{"type":"string"},"fhirStatus":{"type":"string","enum":["delayed","initiated","pending","inProgress","completed","exhausted","error"]},"ccdaStatus":{"type":"string","enum":["delayed","initiated","pending","inProgress","completed","exhausted","error"]},"queryAttempts":{"type":"array","items":{"$ref":"#/components/schemas/QueryAttempt"}}},"required":["id","subjectId","created","userId"]}},"components/schemas/QueryPaginationResult":{"id":"components/schemas/QueryPaginationResult","kind":"json-schema","title":"QueryPaginationResult","data":{"type":"object","properties":{"pageNumber":{"type":"number","default":1,"description":"Page number to retrieve (1-based index)"},"pageSize":{"type":"number","default":50,"description":"Number of items per page"},"sortField":{"type":"string","default":"created","description":"Field name to sort by"},"sortIsDescending":{"type":"boolean","default":false,"description":"Whether to sort in descending order"},"totalCount":{"type":"number","description":"Total number of items matching the query"},"results":{"description":"List of results for the current page","type":"array","items":{"$ref":"#/components/schemas/Query"}}},"required":["totalCount","results"]}},"components/schemas/GetQueryResponse":{"id":"components/schemas/GetQueryResponse","kind":"json-schema","title":"GetQueryResponse","data":{"type":"object","properties":{"id":{"type":"string"},"subjectId":{"type":"string"},"created":{"format":"date-time","type":"string"},"userId":{"type":"string"},"fhirStatus":{"type":"string","enum":["delayed","initiated","pending","inProgress","completed","exhausted","error"]},"ccdaStatus":{"type":"string","enum":["delayed","initiated","pending","inProgress","completed","exhausted","error"]}},"required":["id","subjectId","created","userId"]}},"components/schemas/CreateQueryDto":{"id":"components/schemas/CreateQueryDto","kind":"json-schema","title":"CreateQueryDto","data":{"type":"object","properties":{"subjectId":{"type":"string","description":"The ID of the subject for whom the query is being created.","example":"1782b464-ab03-4c03-9810-83d42b86e587"},"organizationIds":{"description":"A list of organization IDs associated with the query.","example":["2.16.840.1.113883.3.3126.2.3.32103.16"],"type":"array","items":{"type":"string"}}},"required":["subjectId"]}},"components/schemas/QueryDto":{"id":"components/schemas/QueryDto","kind":"json-schema","title":"QueryDto","data":{"type":"object","properties":{"id":{"type":"string"},"subjectId":{"type":"string"},"created":{"format":"date-time","type":"string"},"fhirStatus":{"type":"string","enum":["delayed","initiated","pending","inProgress","completed","exhausted","error"]},"ccdaStatus":{"type":"string","enum":["delayed","initiated","pending","inProgress","completed","exhausted","error"]},"userId":{"type":"string"},"externalPatientId":{"type":"string"},"externalQueryId":{"type":"string"},"queryAttempts":{"type":"array","items":{"type":"string"}}},"required":["id","subjectId","created","fhirStatus","ccdaStatus","userId","externalPatientId","externalQueryId","queryAttempts"]}},"components/schemas/ReferencedDocumentDto":{"id":"components/schemas/ReferencedDocumentDto","kind":"json-schema","title":"ReferencedDocumentDto","data":{"type":"object","properties":{"documentId":{"type":"string","description":"The unique identifier of the document.","example":"doc12345"},"referencedStrings":{"description":"A list of strings referenced in the document.","example":["string1","string2","string3"],"type":"array","items":{"type":"string"}}},"required":["documentId","referencedStrings"]}},"components/schemas/SubjectSummaryDto":{"id":"components/schemas/SubjectSummaryDto","kind":"json-schema","title":"SubjectSummaryDto","data":{"type":"object","properties":{"overview":{"type":"string","description":"An overview or summary of the subject.","example":"This is a summary of the subject's details."},"referencedDocuments":{"description":"A list of documents referenced in the subject summary.","example":[{"documentId":"doc12345","referencedStrings":["string1","string2"]},{"documentId":"doc67890","referencedStrings":["stringA","stringB"]}],"type":"array","items":{"$ref":"#/components/schemas/ReferencedDocumentDto"}}},"required":["overview","referencedDocuments"]}},"components/schemas/FhirExportResponseDto":{"id":"components/schemas/FhirExportResponseDto","kind":"json-schema","title":"FhirExportResponseDto","data":{"type":"object","properties":{"transactionTime":{"format":"date-time","type":"string","description":"When the export request was made."},"expires":{"format":"date-time","type":"string","description":"When the resulting output URL(s) will expire."},"requiresAccessToken":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the requests represented by in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"output"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array require an access token."},"children":[]}]}]}]},"output":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resulting FHIR resource output will be a collection of FHIR resources in "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://jsonlines.org/","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Lines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, with one FHIR resource per line. Please see the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://hl7.org/fhir/R4/bundle.html","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FHIR R4 resource definitions."},"children":[]}]}]}]}],"type":"array","items":{"type":"string"}}},"required":["transactionTime","expires","requiresAccessToken","output"]}},"components/schemas/CreateDocumentRequest":{"id":"components/schemas/CreateDocumentRequest","kind":"json-schema","title":"CreateDocumentRequest","data":{"type":"object","properties":{"subjectId":{"type":"string"},"documentName":{"type":"string","description":"Display name for this document"},"documentDate":{"format":"date-time","type":"string"},"fileName":{"type":"string"},"informationTypes":{"description":"Document Classifications (an Array of strings)","type":"array","items":{"type":"string"}},"contentType":{"type":"string","format":"MIME","example":"application/xml"}},"required":["subjectId","fileName","contentType"]}},"components/schemas/CreateDocumentResponse":{"id":"components/schemas/CreateDocumentResponse","kind":"json-schema","title":"CreateDocumentResponse","data":{"type":"object","properties":{"documentId":{"type":"string"},"signedS3Url":{"type":"string"}},"required":["documentId","signedS3Url"]}},"components/schemas/DocumentSummary":{"id":"components/schemas/DocumentSummary","kind":"json-schema","title":"DocumentSummary","data":{"type":"object","properties":{"id":{"type":"string"},"created":{"format":"date-time","type":"string"},"updated":{"format":"date-time","type":"string"},"subjectId":{"type":"string"},"source":{"type":"string","enum":["fhir","ccda","box","userUpload","patientFhir"]},"sourceId":{"type":"string"},"documentName":{"type":"string","description":"Display name for this document"},"documentLocation":{"type":"string"},"documentDate":{"format":"date-time","type":"string"},"fileName":{"type":"string"},"contentType":{"type":"string"},"informationTypes":{"description":"Document Classifications (an Array of strings)","type":"array","items":{"type":"string"}}},"required":["id","created","updated","subjectId","fileName"]}},"components/schemas/DocumentPaginationResult":{"id":"components/schemas/DocumentPaginationResult","kind":"json-schema","title":"DocumentPaginationResult","data":{"type":"object","properties":{"pageNumber":{"type":"number","default":1,"description":"Page number to retrieve (1-based index)"},"pageSize":{"type":"number","default":50,"description":"Number of items per page"},"sortField":{"type":"string","default":"created","description":"Field name to sort by"},"sortIsDescending":{"type":"boolean","default":false,"description":"Whether to sort in descending order"},"totalCount":{"type":"number","description":"Total number of items matching the query"},"results":{"description":"List of results for the current page","type":"array","items":{"$ref":"#/components/schemas/DocumentSummary"}}},"required":["totalCount","results"]}},"components/schemas/DocumentDetail":{"id":"components/schemas/DocumentDetail","kind":"json-schema","title":"DocumentDetail","data":{"type":"object","properties":{"id":{"type":"string"},"created":{"format":"date-time","type":"string"},"updated":{"format":"date-time","type":"string"},"subjectId":{"type":"string"},"source":{"type":"string","enum":["fhir","ccda","box","userUpload","patientFhir"]},"sourceId":{"type":"string"},"documentName":{"type":"string","description":"Display name for this document"},"documentLocation":{"type":"string"},"documentDate":{"format":"date-time","type":"string"},"fileName":{"type":"string"},"contentType":{"type":"string"},"signedS3Url":{"type":"string"}},"required":["id","created","updated","subjectId","fileName","signedS3Url"]}},"components/schemas/UpdateDocumentRequest":{"id":"components/schemas/UpdateDocumentRequest","kind":"json-schema","title":"UpdateDocumentRequest","data":{"type":"object","properties":{"documentName":{"type":"string","description":"Display name for this document"},"documentLocation":{"type":"string"},"documentDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"}}}},"components/schemas/DocumentReciprocityDto":{"id":"components/schemas/DocumentReciprocityDto","kind":"json-schema","title":"DocumentReciprocityDto","data":{"type":"object","properties":{"templateId":{"type":"string","format":"uuid","example":"c8ffe813-1e61-42aa-a26f-a0e9ab6ed1fd","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the template to use for reciprocity. See available templates at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/patient-registry/reciprocity-template"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["templateId"]}},"components/schemas/DocumentPdfUrlDto":{"id":"components/schemas/DocumentPdfUrlDto","kind":"json-schema","title":"DocumentPdfUrlDto","data":{"type":"object","properties":{"fileName":{"type":"string","description":"The name of the PDF file."},"signedUrl":{"type":"string","description":"A signed URL to download the PDF. Valid for 15 minutes."}},"required":["fileName","signedUrl"]}},"components/schemas/PublishDocumentTemplateDto":{"id":"components/schemas/PublishDocumentTemplateDto","kind":"json-schema","title":"PublishDocumentTemplateDto","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"c8ffe813-1e61-42aa-a26f-a0e9ab6ed1fd"},"projectId":{"type":"string"},"name":{"type":"string"},"author":{"type":"string"},"title":{"type":"string"},"displayName":{"type":"string"},"loincCode":{"type":"string"},"created":{"format":"date-time","type":"string"},"updated":{"format":"date-time","type":"string"},"providerOrganizationId":{"type":"string"},"providerOrganizationName":{"type":"string"},"providerAddressLine1":{"type":"string"},"providerAddressLine2":{"type":"string"},"providerAddressCity":{"type":"string"},"providerAddressState":{"type":"string"},"providerAddressPostalCode":{"type":"string"},"providerPhoneNumber":{"type":"string"}},"required":["id","projectId","name","author","title","displayName","loincCode","created","updated"]}},"components/schemas/ChecklistItem":{"id":"components/schemas/ChecklistItem","kind":"json-schema","title":"ChecklistItem","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"libraryItemId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checklist library item ID. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"static"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type checklists, identifies the library item type. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"questionnaire"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type checklists, uniquely identifies the item in the checklist."},"children":[]}]}]}]},"name":{"type":"string","description":"Display name of the checklist item."},"sortOrder":{"type":"number","description":"Order in which to display this checklist item."}},"required":["id","libraryItemId","name","sortOrder"]}},"components/schemas/Checklist":{"id":"components/schemas/Checklist","kind":"json-schema","title":"Checklist","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"Display name of the checklist."},"sortOrder":{"type":"number","description":"Order in which the checklist is displayed."},"items":{"description":"Items in the checklist.","type":"array","items":{"$ref":"#/components/schemas/ChecklistItem"}}},"required":["id","name","sortOrder","items"]}},"components/schemas/ChecklistEvaluationRequest":{"id":"components/schemas/ChecklistEvaluationRequest","kind":"json-schema","title":"ChecklistEvaluationRequest","data":{"type":"object","properties":{"subjectId":{"type":"string","format":"uuid","description":"The ID of the subject to evaluate the checklist for."},"regenerate":{"type":"boolean","description":"If true, forces regeneration of the checklist evaluation even if a recent evaluation exists."}},"required":["subjectId"]}},"components/schemas/ClinicalConceptDto":{"id":"components/schemas/ClinicalConceptDto","kind":"json-schema","title":"ClinicalConceptDto","data":{"type":"object","properties":{"clinicalConceptId":{"type":"string","description":"The ID of the clinical concept."},"entityType":{"type":"string","description":"The type of clinical concept."}},"required":["clinicalConceptId","entityType"]}},"components/schemas/DocumentSectionDto":{"id":"components/schemas/DocumentSectionDto","kind":"json-schema","title":"DocumentSectionDto","data":{"type":"object","properties":{"documentId":{"type":"string","description":"The ID of the document this section appears in."},"sectionType":{"type":"string","enum":["ccda","page"],"description":"The type of document section."},"section":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uniquely identifies this section within the document. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ccda"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sectionTypes, this is the CCDA section code. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sectionTypes, this is the page number."},"children":[]}]}]}]},"sectionTitle":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ccda"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type sections, the title of the section."},"children":[]}]}]}]},"documentName":{"type":"string","description":"The name of the document."},"documentLocation":{"type":"string","description":"The facility or location associated with this document."},"documentContentType":{"type":"string","description":"The document content MIME type."},"documentDate":{"format":"date-time","type":"string","description":"The date associated with the document, when known. May be absent."},"documentFileSizeBytes":{"type":"number","description":"The size of the document in bytes."}},"required":["documentId","sectionType","section","documentContentType"]}},"components/schemas/ChecklistItemEvaluationResult":{"id":"components/schemas/ChecklistItemEvaluationResult","kind":"json-schema","title":"ChecklistItemEvaluationResult","data":{"type":"object","properties":{"checklistItem":{"description":"Checklist item that was evaluated.","allOf":[{"$ref":"#/components/schemas/ChecklistItem"}]},"checklistItemDefinitionId":{"type":"string","format":"uuid","description":"ID of the checklist item definition this answer was produced from. Stable across evaluations of the same item."},"checklistItemDefinitionVersionId":{"type":"string","format":"uuid","description":"ID of the specific checklist item definition version this answer was produced against. Item definitions are versioned, and answers produced by different versions are not directly comparable. Use this to pin an answer to the exact version that generated it."},"meetsCriteria":{"type":"boolean","description":"Whether this checklist item's criteria is satisfied, i.e. if the checkbox should be checked."},"matchingRecords":{"deprecated":true,"description":"Deprecated in favor of clinicalConcepts. This will be an empty array.","type":"array","items":{"type":"object"}},"documentIds":{"description":"IDs of the source documents that are relevant to this checklist item.","type":"array","items":{"type":"string"}},"clinicalConcepts":{"description":"Structured clinical records that are relevant to this checklist item.","type":"array","items":{"$ref":"#/components/schemas/ClinicalConceptDto"}},"documentSections":{"description":"Document sections that are relevant to this checklist item.","type":"array","items":{"$ref":"#/components/schemas/DocumentSectionDto"}},"result":{"type":"object","description":"The result of this checklist item's evaluation."}},"required":["checklistItem","meetsCriteria","matchingRecords","documentIds","clinicalConcepts","documentSections"]}},"components/schemas/ChecklistEvaluationResult":{"id":"components/schemas/ChecklistEvaluationResult","kind":"json-schema","title":"ChecklistEvaluationResult","data":{"type":"object","properties":{"subjectId":{"type":"string","format":"uuid","description":"ID of the subject being evaluated."},"checklistId":{"type":"string","format":"uuid","description":"ID of the checklist being evaluated."},"eligibilitySatisfied":{"type":"boolean","description":"Whether the checklist's minimum criteria have been met."},"items":{"description":"Evaluation results of the indvidual checklist items.","type":"array","items":{"$ref":"#/components/schemas/ChecklistItemEvaluationResult"}},"documentIds":{"description":"IDs of the source documents associated with all of the satisfied checklist items.","type":"array","items":{"type":"string"}}},"required":["subjectId","checklistId","eligibilitySatisfied","items","documentIds"]}},"components/schemas/ChecklistItemFeedbackRequest":{"id":"components/schemas/ChecklistItemFeedbackRequest","kind":"json-schema","title":"ChecklistItemFeedbackRequest","data":{"type":"object","properties":{"subjectId":{"type":"string","format":"uuid","description":"ID of the subject to submit feedback for."},"feedbackType":{"type":"string","enum":["positive","negative","harmful"],"example":"positive","description":"The type of feedback being submitted."},"comment":{"type":"string","description":"Optional comment providing additional context for the feedback. Required when feedbackType is harmful."}},"required":["subjectId","feedbackType"]}},"components/schemas/PaginationResultDto":{"id":"components/schemas/PaginationResultDto","kind":"json-schema","title":"PaginationResultDto","data":{"type":"object","properties":{"pageNumber":{"type":"number","default":1,"description":"Page number to retrieve (1-based index)"},"pageSize":{"type":"number","default":50,"description":"Number of items per page"},"sortField":{"type":"string","default":"created","description":"Field name to sort by"},"sortIsDescending":{"type":"boolean","default":false,"description":"Whether to sort in descending order"},"totalCount":{"type":"number","description":"Total number of items matching the query"},"results":{"description":"List of results for the current page","type":"array","items":{"type":"object"}}},"required":["totalCount","results"]}},"components/schemas/ClinicalConceptConditionDto":{"id":"components/schemas/ClinicalConceptConditionDto","kind":"json-schema","title":"ClinicalConceptConditionDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the condition"},"documentIds":{"description":"List of document IDs associated with the condition","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"bodySites":{"description":"Body sites affected by the condition","type":"array","items":{"type":"string"}},"clinicalStatus":{"type":"string","description":"Clinical status of the condition"},"conditionName":{"type":"string","description":"Condition name"},"isCancerRelated":{"type":"boolean","description":"Whether the condition is cancer related"},"onsetDate":{"format":"date-time","type":"string","description":"Onset date of the condition"},"stage":{"type":"string","description":"Stage of the condition"},"metastaticSites":{"type":"string","description":"Metastatic sites"},"histologyAndMorphology":{"type":"string","description":"Histology and morphology details"},"encounterDate":{"type":"string","description":"Date of the encounter associated with this condition"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptMedicationDto":{"id":"components/schemas/ClinicalConceptMedicationDto","kind":"json-schema","title":"ClinicalConceptMedicationDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the medication record"},"documentIds":{"description":"List of document IDs associated with the medication","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"startDate":{"format":"date-time","type":"string","description":"Start date of the medication"},"endDate":{"format":"date-time","type":"string","description":"End date of the medication"},"status":{"type":"string","description":"Status of the medication"},"reason":{"type":"string","description":"Reason for the medication"},"route":{"type":"string","description":"Route of administration"},"dose":{"type":"number","description":"Dose amount"},"doseUnit":{"type":"string","description":"Dose unit"},"patientInstruction":{"type":"string","description":"Patient instruction for the medication"},"regimen":{"type":"string","description":"Regimen for the medication"},"discontinuationReason":{"type":"string","description":"Reason for discontinuation"},"medicationName":{"type":"string","description":"Medication name"},"medicationCode":{"type":"string","description":"Medication code"},"medicationCodingSystem":{"type":"string","description":"Coding system for the medication"},"notes":{"description":"Notes related to the medication","type":"array","items":{"type":"string"}},"ingredients":{"description":"List of drug ingredients","type":"array","items":{"type":"object"}},"oncologyClassification":{"type":"string","description":"Oncology classification for the medication"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptAllergyDto":{"id":"components/schemas/ClinicalConceptAllergyDto","kind":"json-schema","title":"ClinicalConceptAllergyDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the allergy record"},"documentIds":{"description":"List of document IDs associated with the allergy","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"allergy":{"type":"string","description":"Allergy name or description"},"onsetDate":{"type":"string","description":"Onset date of the allergy (ISO string)"},"recordedDate":{"type":"string","description":"Date the allergy was recorded (ISO string)"},"clinicalStatus":{"type":"string","description":"Clinical status of the allergy"},"reaction":{"type":"string","description":"Reaction to the allergy"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptProcedureDto":{"id":"components/schemas/ClinicalConceptProcedureDto","kind":"json-schema","title":"ClinicalConceptProcedureDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the procedure record"},"documentIds":{"description":"List of document IDs associated with the procedure","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"procedure":{"type":"string","description":"Procedure name or description"},"procedureLocation":{"type":"string","description":"Location where the procedure was performed"},"procedureReason":{"type":"string","description":"Reason for the procedure"},"procedureStartDate":{"type":"string","description":"Start date of the procedure (ISO string)"},"procedureEndDate":{"type":"string","description":"End date of the procedure (ISO string)"},"cancerRelated":{"type":"boolean","description":"Whether the procedure is cancer related"},"procedureCategory":{"type":"string","description":"Category of the procedure"},"status":{"type":"string","description":"Status of the procedure"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptBiomarkerDto":{"id":"components/schemas/ClinicalConceptBiomarkerDto","kind":"json-schema","title":"ClinicalConceptBiomarkerDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the biomarker record"},"documentIds":{"description":"List of document IDs associated with the biomarker","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"biomarker":{"type":"string","description":"Name of the biomarker"},"alteration":{"type":"string","description":"Alteration of the biomarker"},"interpretation":{"type":"string","description":"Interpretation of the biomarker"},"vaf":{"type":"number","description":"Variant allele frequency (VAF)"},"results":{"type":"number","description":"Results value for the biomarker"},"resultsValue":{"type":"string","description":"String representation of the biomarker result"},"impact":{"type":"string","description":"Impact of the biomarker"},"method":{"type":"string","description":"Method used for biomarker detection"},"diagnosticReport":{"type":"string","description":"Diagnostic report details"},"reportDate":{"type":"string","description":"Date of the report (ISO string)"},"collectionDate":{"type":"string","description":"Date of specimen collection (ISO string)"},"specimenLocation":{"type":"string","description":"Location of the specimen"},"sourceClass":{"type":"string","description":"Genomic source class (Germline, Somatic, Unknown)"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptCoverageDto":{"id":"components/schemas/ClinicalConceptCoverageDto","kind":"json-schema","title":"ClinicalConceptCoverageDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the coverage record"},"documentIds":{"description":"List of document IDs associated with the coverage","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"coverage":{"type":"string","description":"The name of the coverage"},"coverageStart":{"type":"string","description":"Coverage start date (ISO string)"},"coverageEnd":{"type":"string","description":"Coverage end date (ISO string)"},"payor":{"type":"string","description":"Payor for the coverage"},"payorType":{"type":"string","description":"Type of payor"},"relationship":{"type":"string","description":"Relationship to the subscriber"},"subscriberType":{"type":"string","description":"Type of subscriber"},"subscriberId":{"type":"string","description":"Subscriber/member insurance ID"},"groupNumber":{"type":"string","description":"Insurance group number"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptDemographicDto":{"id":"components/schemas/ClinicalConceptDemographicDto","kind":"json-schema","title":"ClinicalConceptDemographicDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the demographic record"},"documentIds":{"description":"List of document IDs associated with the demographic","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"birthdate":{"type":"string","description":"Birthdate (ISO string)"},"deathdate":{"type":"string","description":"Deathdate (ISO string)"},"gender":{"type":"string","description":"Gender of the subject"},"race":{"type":"string","description":"Race of the subject"},"ethnicity":{"type":"string","description":"Ethnicity of the subject"},"deceased":{"type":"boolean","description":"Whether the subject is deceased"},"addressPostalCode":{"type":"string","description":"Postal code of the subject address"},"demographic":{"type":"string","description":"Demographic Name"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptEncounterDto":{"id":"components/schemas/ClinicalConceptEncounterDto","kind":"json-schema","title":"ClinicalConceptEncounterDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the encounter record"},"documentIds":{"description":"List of document IDs associated with the encounter","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"encounterDate":{"type":"string","description":"Date of the encounter (ISO string)"},"encounterType":{"type":"string","description":"Type of the encounter"},"locationType":{"type":"string","description":"Type of location for the encounter"},"locationName":{"type":"string","description":"Name of the location for the encounter"},"address":{"type":"string","description":"Address of the encounter location"},"city":{"type":"string","description":"City of the encounter location"},"state":{"type":"string","description":"State of the encounter location"},"postalcode":{"type":"string","description":"Postal code of the encounter location"},"providerFirstName":{"type":"string","description":"Provider first name"},"providerMiddleName":{"type":"string","description":"Provider middle name"},"providerLastName":{"type":"string","description":"Provider last name"},"providerSuffix":{"type":"string","description":"Provider suffix (e.g. MD, DO)"},"encounterDiagnosis":{"type":"string","description":"Diagnosis associated with the encounter"},"dischargeDisposition":{"type":"string","description":"Discharge disposition for the encounter"},"encounter":{"type":"string","description":"Class of the encounter"},"npi":{"type":"string","description":"The provider's National Provider Identifier"},"specialty":{"type":"string","description":"The provider's specialty"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptFamilyHistoryDto":{"id":"components/schemas/ClinicalConceptFamilyHistoryDto","kind":"json-schema","title":"ClinicalConceptFamilyHistoryDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the family history record"},"documentIds":{"description":"List of document IDs associated with the family history","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"condition":{"type":"string","description":"Condition in the family history"},"ageAtOnset":{"type":"string","description":"Age at onset of the condition"},"relationship":{"type":"string","description":"Relationship to the subject"},"cancerRelated":{"type":"boolean","description":"Whether the condition is cancer related"},"isCancerRelated":{"type":"boolean","description":"Whether the family history is cancer related"},"familyHistory":{"type":"string","description":"Name for the family history"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptImagingDto":{"id":"components/schemas/ClinicalConceptImagingDto","kind":"json-schema","title":"ClinicalConceptImagingDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the imaging record"},"documentIds":{"description":"List of document IDs associated with the imaging","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"procedure":{"type":"string","description":"Procedure name or description"},"procedureLocation":{"type":"string","description":"Location where the procedure was performed"},"procedureReason":{"type":"string","description":"Reason for the procedure"},"procedureStartDate":{"type":"string","description":"Start date of the procedure (ISO string)"},"procedureEndDate":{"type":"string","description":"End date of the procedure (ISO string)"},"procedureCategory":{"type":"string","description":"Category of the procedure"},"status":{"type":"string","description":"Status of the imaging"},"findings":{"type":"string","description":"Findings from the imaging"},"impression":{"type":"string","description":"Impression from the imaging"},"impressionSummary":{"type":"string","description":"Summary of the impression"},"description":{"type":"string","description":"Description of the imaging"},"dim1":{"type":"number","description":"Lesion size, first dimension (e.g., length)"},"dim2":{"type":"number","description":"Lesion size, second dimension (e.g., width)"},"dim3":{"type":"number","description":"Lesion size, third dimension (e.g., depth)"},"lesionLocation":{"type":"string","description":"Location of the lesion"},"isCancerRelated":{"type":"boolean","description":"Whether the imaging is cancer related"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptLabDto":{"id":"components/schemas/ClinicalConceptLabDto","kind":"json-schema","title":"ClinicalConceptLabDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the lab record"},"documentIds":{"description":"List of document IDs associated with the lab","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"lab":{"type":"string","description":"Lab name or description"},"labDate":{"type":"string","description":"Date of the lab (ISO string)"},"labResult":{"type":"string","description":"Result of the lab"},"labResultUnit":{"type":"string","description":"Unit of the lab result"},"labResultInterpretation":{"type":"string","description":"Interpretation of the lab result"},"rangeHigh":{"type":"string","description":"High end of the reference range"},"rangeLow":{"type":"string","description":"Low end of the reference range"},"labResultValue":{"type":"string","description":"Value of the lab result"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptSocialHistoryDto":{"id":"components/schemas/ClinicalConceptSocialHistoryDto","kind":"json-schema","title":"ClinicalConceptSocialHistoryDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the social history record"},"documentIds":{"description":"List of document IDs associated with the social history","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"socialHistory":{"type":"string","description":"Social history description"},"socialHistoryDate":{"type":"string","description":"Date of the social history (ISO string)"},"result":{"type":"string","description":"The observed result of the social history"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptSurveyDto":{"id":"components/schemas/ClinicalConceptSurveyDto","kind":"json-schema","title":"ClinicalConceptSurveyDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the survey record"},"documentIds":{"description":"List of document IDs associated with the survey","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"survey":{"type":"string","description":"Survey name or description"},"surveyDate":{"type":"string","description":"Date of the survey (ISO string)"},"surveyResult":{"type":"string","description":"Result of the survey"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptRadiationDto":{"id":"components/schemas/ClinicalConceptRadiationDto","kind":"json-schema","title":"ClinicalConceptRadiationDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the radiation record"},"documentIds":{"description":"List of document IDs associated with the radiation","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"fractionsPlanned":{"type":"number","description":"Number of fractions planned"},"fractionsCompleted":{"type":"number","description":"Number of fractions completed"},"totalDosePlanned":{"type":"number","description":"Total radiation dose planned"},"totalDoseCompleted":{"type":"number","description":"Total radiation dose completed"},"dosageUnits":{"type":"string","description":"Units of dosage (e.g. Gy, cGy)"},"description":{"type":"string","description":"Description of the radiation treatment"},"startDate":{"type":"string","description":"Start date of the radiation treatment (ISO string)"},"endDate":{"type":"string","description":"End date of the radiation treatment (ISO string)"},"bodySite":{"type":"string","description":"Body site targeted by radiation"},"status":{"type":"string","description":"Status of the radiation treatment"},"isCancerRelated":{"type":"boolean","description":"Whether the radiation is cancer related"},"radiation":{"type":"string","description":"Name of the radiation concept"}},"required":["id","documentIds"]}},"components/schemas/ClinicalConceptVitalDto":{"id":"components/schemas/ClinicalConceptVitalDto","kind":"json-schema","title":"ClinicalConceptVitalDto","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the vital record"},"documentIds":{"description":"List of document IDs associated with the vital","type":"array","items":{"type":"string"}},"codes":{"description":"Codes from source documents. Type \"standard\" indicates the code that determined the OMOP concept assignment","type":"array","items":{"type":"string"}},"vitals":{"type":"string","description":"Vitals name or description"},"vitalsDate":{"type":"string","description":"Date of the vitals (ISO string)"},"vitalsResult":{"type":"string","description":"Result of the vitals"},"vitalsResultUnit":{"type":"string","description":"Unit of the vitals result"},"vitalsResultValue":{"type":"string","description":"Value of the vitals result"},"rangeHigh":{"type":"string","description":"Upper bound of the reference range"},"rangeLow":{"type":"string","description":"Lower bound of the reference range"}},"required":["id","documentIds"]}},"components/schemas/Project":{"id":"components/schemas/Project","kind":"json-schema","title":"Project","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e6b01018-a333-4732-917e-fe38e91b0fdf"},"name":{"type":"string","example":"My Project"},"created":{"format":"ISO 8601","type":"string","example":"2025-05-26T23:30:40.912Z","readOnly":true},"updated":{"format":"ISO 8601","type":"string","example":"2025-05-26T23:30:40.912Z","readOnly":true}},"required":["id","name","created","updated"]}},"components/schemas/ProblemDetails":{"id":"components/schemas/ProblemDetails","kind":"json-schema","title":"ProblemDetails","data":{"type":"object","properties":{"status":{"type":"number","format":"000"},"title":{"type":"string"},"detail":{"type":"string"}}}},"components/schemas/CreateSubjectOptions":{"id":"components/schemas/CreateSubjectOptions","kind":"json-schema","title":"CreateSubjectOptions","data":{"type":"object","properties":{"initiateEhrQuery":{"type":"boolean","description":"When true, initiates an EHR query for the subject after creation. Defaults to true when omitted.","default":true}}}},"components/schemas/CreateSubjectV2":{"id":"components/schemas/CreateSubjectV2","kind":"json-schema","title":"CreateSubjectV2","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"firstName":{"type":"string","example":"David"},"middleName":{"type":"string","example":"Quincy","description":"Full middle name or a bare initial; omit if the subject has none. An update that omits this field clears any stored value."},"lastName":{"type":"string","example":"Mann"},"email":{"type":"string","format":"email","example":"david.mann@example.com"},"birthDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"},"deathDate":{"format":"yyyy-mm-dd","type":"string","example":"2023-05-26"},"gender":{"type":"string","enum":["M","F",null],"example":"M","description":"For guaranteed long term compatibility we recommend using the single character gender identifiers. We will optimistically accept other formats like 'male' and 'female'."},"addressLine1":{"type":"string","example":"123 Main St."},"addressLine2":{"type":"string","example":"Apt 4B"},"addressCity":{"type":"string","example":"Minneapolis"},"addressState":{"type":"string","format":"XX","example":"MN","description":"Two letter state code"},"addressPostalCode":{"type":"string","format":"00000","example":"55401","description":"5 or 9 digit postal code"},"phoneNumber":{"type":"string","example":"123-456-7890"},"externalIdentifiers":{"example":[{"externalIdentifier":"12345","externalSystem":"Hospital A"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectExternalIdentifier"}},"labels":{"example":["label_1","Label 2"],"type":"array","items":{"type":"string"}},"additionalNames":{"example":[{"first":"Dave","last":"Mann"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectAdditionalName"}},"additionalAddresses":{"example":[{"addressLine1":"456 Other St.","addressCity":"Saint Paul","addressState":"MN","addressPostalCode":"55101"}],"type":"array","items":{"$ref":"#/components/schemas/SubjectAddressDto"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/SubjectTagDto"}},"options":{"$ref":"#/components/schemas/CreateSubjectOptions"}},"required":["id","firstName","lastName"]}},"schema_33":{"kind":"json-schema","data":{"default":1,"type":"number"},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"default":50,"type":"number"},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"default":"identifier","type":"string"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"default":false,"type":"boolean"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"string"},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"format":"uuid","type":"array","items":{"type":"string"}},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"number"},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"e6b01018-a333-4732-917e-fe38e91b0fdf"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/CreateSubject"},"description":"Array of subjects to create. Maximum of 10 subjects allowed."},{"$ref":"#/components/schemas/CreateSubjectBatch"}]},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CreateSubjectResult"}},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"default":"created","enum":["created","ccdaStatus","externalSystem"],"type":"string"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"enum":["delayed","initiated","pending","inProgress","completed","exhausted","error"],"type":"string"},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"format":"ISO 8601","example":"2025-05-26T23:30:40.912Z","type":"string"},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"default":"created","type":"string"},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"format":"uuid","type":"string"},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentDetail"}},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"object","properties":{"content-type":{"type":"string","enum":["application/json+fhir"]}}},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"object","properties":{"content-type":{"type":"string","enum":["application/json"]},"expires":{"type":"string","example":"Wed, 21 Oct 2023 07:28:00 GMT","description":"Indicates when the resulting output URL(s) will expire."}}},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"default":"score","enum":["date","score"],"type":"string"},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"example":"123e4567-e89b-12d3-a456-426614174000","type":"string"},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"example":"2025-01-01","type":"string"},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"example":"2025-12-31","type":"string"},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"example":"aspirin","type":"string"},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"enum":["lexical","semantic","hybrid"],"type":"string"},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"example":"E11.9","type":"string"},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"example":"http://hl7.org/fhir/sid/icd-10","type":"string"},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"default":"questionnaire","enum":["questionnaire"],"type":"string"},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Checklist"}},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PublishDocumentTemplateDto"}},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Project"}},"id":"schema_65"}},"exampleStore":{"paths/~1api~1v2~1patient-registry~1subject/post/responses/400/content/application~1json/example":{"value":{"title":"Bad Request","status":400,"detail":"<details about the bad request>"},"id":"paths/~1api~1v2~1patient-registry~1subject/post/responses/400/content/application~1json/example"},"paths/~1api~1v2~1patient-registry~1subject/post/responses/403/content/application~1json/example":{"value":{"title":"Forbidden","status":403,"detail":"Forbidden resource"},"id":"paths/~1api~1v2~1patient-registry~1subject/post/responses/403/content/application~1json/example"},"paths/~1api~1v2~1patient-registry~1subject/post/responses/409/content/application~1json/example":{"value":{"title":"Conflict","status":409,"detail":"<details about the conflict>"},"id":"paths/~1api~1v2~1patient-registry~1subject/post/responses/409/content/application~1json/example"},"paths/~1api~1v2~1patient-registry~1subject/post/responses/429/content/application~1json/example":{"value":{"title":"Too Many Requests","status":429,"detail":"<details about request throttling issues>"},"id":"paths/~1api~1v2~1patient-registry~1subject/post/responses/429/content/application~1json/example"},"paths/~1api~1v2~1patient-registry~1subject/post/responses/500/content/application~1json/example":{"value":{"title":"Internal Server Error","status":500,"detail":"<details about the internal error>"},"id":"paths/~1api~1v2~1patient-registry~1subject/post/responses/500/content/application~1json/example"},"paths/~1api~1v2~1patient-registry~1subject/post/responses/503/content/application~1json/example":{"value":{"title":"Service Unavailable","status":503,"detail":"<details about the service unavailability>"},"id":"paths/~1api~1v2~1patient-registry~1subject/post/responses/503/content/application~1json/example"},"paths/~1api~1v1~1patient-registry~1query/post/requestBody/content/application~1json/examples/example1":{"value":{"subjectId":"1782b464-ab03-4c03-9810-83d42b86e587","organizationIds":["2.16.840.1.113883.3.3126.2.3.32103.16"]},"key":"example1","summary":"Example Query Creation","id":"paths/~1api~1v1~1patient-registry~1query/post/requestBody/content/application~1json/examples/example1"}},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"https://partner.xcures.com"}],"logo":{"imageUrl":"https://prod-xc-public-marketing.s3.us-west-2.amazonaws.com/xCures-emails-logo.png"}},"options":{"sortRequiredPropsFirst":true,"hideInfoMetadata":true,"codeSamples":{"languages":[{"lang":"curl","label":"cURL"},{"lang":"JavaScript"},{"lang":"Python"},{"lang":"Node.js"},{"lang":"Java"},{"lang":"PHP"},{"lang":"C#"},{"lang":"Ruby"}]},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/current.json?download"},{"url":"/_bundle/apis/current.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"xCures API","description":"# Authentication\nOur API requires a Bearer Token in the `Authorization` header for auth. Most of our endpoints also require a `ProjectId` header to set the context of the request. It must be one of the projects the api client has permissions to.\n\n### Getting a token\nTo get a token, use your `client_id` and `client_secret` to execute a client credentials exchange.\n\n#### Example CURL command:\n\n    curl --request POST \\\n        --url https://partner.xcures.com/oauth/token \\\n        --header 'content-type: application/json' \\\n        --data '{\"client_id\":\"{your_client_id}\",\"client_secret\":\"{your_client_secret}\",\"grant_type\":\"client_credentials\"}'\n        \n#### Response:\n\n    {\n        \"access_token\": \"{your_temporary_access_token}\",\n        \"token_type\": \"Bearer\"\n    }\n\n### Using the token with our API:\nNow just include that bearer token in the `Authorization` header of your requests to our API.\n\n#### Example authorized request:\n\n    curl --request GET \\\n        --url https://partner.xcures.com/api/v1/patient-registry/subject \\\n        --header 'ProjectId: {your_project_id}' \\\n        --header 'authorization: Bearer {your_temporary_access_token}'"}},"baseSlug":"/apis/current","routesMapping":{}}