openapi: 3.2.0 info: title: Cross Community Rest APIs(XC-Rest) Document Search API version: '1.49' description: Documentation for Cross Community API to query and retrieve patient data. contact: email: odx_ncc_foundation@optum.com name: ODX/NCC Foundation Team license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://gateway-nonprod.optuminsightplatform.com/odxcloudxcservicesint variables: {} description: XC-Rest APIs Internal Server(INT) tags: - name: documentSearch paths: /api/xc/v1/clinical/documents/search: summary: Patient Document Search API description: Performs patient search, and also searches for the patient's clinical documents if the patient is found. post: summary: Search patient document description: Search patient document based on the search criteria. operationId: documentSearch security: - bearerAuth: [] requestBody: required: true description: 'DocumentSearchRequest: request object that contains patient information used for patient search.' content: application/xml: schema: $ref: '#/components/schemas/DocumentSearchRequest' examples: documentSearchRequest: value: "\n\n\t\n\t\tSampleHIEUser\n\t\tSequoia HIE\n\t\t1.1.131.1\n\t\t3\n\t\t1.4.3\n\t\todxtst\n\t\tMedical Doctor\n\t\tTREATMENT\n\t\n\t\n\t\t\n\t\t\t11.53.128.2021\n\t\t\t1153.012.8.2021\n\t\t\n\t\t\n\t\t\tViolet\n\t\t\t\n\t\t\t\tViolet\n\t\t\t\n\t\t\n\t\t19820202\n\t\tF\n\t\t\n\t\t\t
\n\t\t\t\tBoston\n\t\t\t\tusa\n\t\t\t\t27511\n\t\t\t\tNC\n\t\t\t\t1154 violet Drive\n\t\t\t\tHP\n\t\t\t
\n\t\t\n\t\t\n\t\t\t\n\t\t\t\tHP\n\t\t\t\ttel:+1-505-243-450\n\t\t\t\n\t\t\t\n\t\t\t\tWP\n\t\t\t\ttel:+6951294567\n\t\t\t\n\t\t\n\t\n\t\n\t\tN\n\t\n" responses: '202': description: DocumentSearchResponse that contains consolidated patient search result's and the patient's clinical documents information. content: application/xml: schema: $ref: '#/components/schemas/DocumentSearchResponse' examples: documentSearchSuccessResponse: description: Document search response when the API is able to successfully fetch the document. value: "\n \n \n 1.1.131.1.2345.1\n Redding Hospital\n \n \n SUCCESS\n \n \n \n 0fdcc407-945d-4b98-b115-f2d831065d30\n 1.1.1.1\n \n \n \n \n Violet\n Violet\n L\n \n \n tel:tel:+1-505-243-450\n HP\n \n \n tel:tel:+6951294567\n WP\n \n \n 76\n AdministrativeGender\n 2.16.840.1.113883.5.1\n F\n Female\n \n \n 27511\n 1154 violet Drive\n NC\n Boston\n USA\n \n \n 19820202\n \n \n \n PAT\n \n \n \n \n \n Clinical Summary (Deduplicated)\n urn:oid:1.1.131.1.2345.1\n 2.16.840.1.113883.3.2966.10.3\n 2.25.195403230751672740758930559008568396222\n 2.16.840.1.113883.6.1\n 34133-9\n Optum HIE\n 00001\n 2023-11-13T15:30:42Z\n Summarization of Episode Note\n Optum HIE\n Redding Hospital\n 6.7.8.9\n \n \n Clinical Summary (Including Duplicates)\n urn:oid:1.1.131.1.2345.1\n 2.16.840.1.113883.3.2966.10.3\n 2.25.85078915595587352936372168036013328244\n 2.16.840.1.113883.6.1\n 34133-9\n Optum HIE\n 00002\n 2023-11-13T15:30:42Z\n Summarization of Episode Note\n Optum HIE\n Redding Hospital\n 6.7.8.9\n \n \n Outpatient Evaluation And Management\n urn:oid:1.1.131.1.2345.1\n LOINCa\n 1152.128.2021\n 2.16.840.1.113883.6.1\n 34133-9\n InGen\n 34108-1\n 2012-02-17T00:00:00Z\n Summarization of episode note\n ^Smittya^Gerald^^^\n Redding Hospital\n 2.3.4.5\n \n \n Outpatient Evaluation And Management\n urn:oid:1.1.131.1.2345.1\n LOINCa\n 1152.128.7451\n 2.16.840.1.113883.6.1\n 34133-9\n InGen\n 34108-1\n 2012-02-17T00:00:00Z\n Summarization of episode note\n ^Smittya^Gerald^^^\n Redding Hospital\n 2.3.4.5\n \n \n Outpatient Evaluation And Management\n urn:oid:1.1.131.1.2345.1\n LOINCa\n 1152.128.2021\n 2.16.840.1.113883.6.1\n 34133-9\n InGen\n 34108-1\n 2012-02-17T00:00:00Z\n Summarization of episode note\n ^Smittya^Gerald^^^\n Redding Hospital\n 2.3.4.5\n \n \n Outpatient Evaluation And Management\n urn:oid:1.1.131.1.2345.1\n LOINCa\n 1152.128.7451\n 2.16.840.1.113883.6.1\n 34133-9\n InGen\n 34108-1\n 2012-02-17T00:00:00Z\n Summarization of episode note\n ^Smittya^Gerald^^^\n Redding Hospital\n 2.3.4.5\n \n \n Outpatient Evaluation And Management\n urn:oid:1.1.131.1.2345.1\n LOINCa\n 1152.128.2023.01\n 2.16.840.1.113883.6.1\n 34133-9\n InGen\n 34108-1\n 2012-02-17T00:00:00Z\n Summarization of episode note\n ^Smittya^Gerald^^^\n Redding Hospital\n 2.3.4.5\n \n \n Outpatient Evaluation And Management\n urn:oid:1.1.131.1.2345.1\n LOINCa\n 1152.128.7451\n 2.16.840.1.113883.6.1\n 34133-9\n InGen\n 34108-1\n 2012-02-17T00:00:00Z\n Summarization of episode note\n ^Smittya^Gerald^^^\n Redding Hospital\n 2.3.4.5\n \n \n Outpatient Evaluation And Management\n urn:oid:1.1.131.1.2345.1\n LOINCa\n 1152.128.2021\n 2.16.840.1.113883.6.1\n 34133-9\n InGen\n 34108-1\n 2012-02-17T00:00:00Z\n Summarization of episode note\n ^Smittya^Gerald^^^\n Redding Hospital\n 2.3.4.5\n \n \n Outpatient Evaluation And Management\n urn:oid:1.1.131.1.2345.1\n LOINCa\n 1152.128.2023.01\n 2.16.840.1.113883.6.1\n 34133-9\n InGen\n 34108-1\n 2012-02-17T00:00:00Z\n Summarization of episode note\n ^Smittya^Gerald^^^\n Redding Hospital\n 2.3.4.5\n \n \n Outpatient Evaluation And Management\n urn:oid:1.1.131.1.2345.1\n LOINCa\n 1152.128.7451\n 2.16.840.1.113883.6.1\n 34133-9\n InGen\n 34108-1\n 2012-02-17T00:00:00Z\n Summarization of episode note\n ^Smittya^Gerald^^^\n Redding Hospital\n 2.3.4.5\n \n \n Outpatient Evaluation And Management\n urn:oid:1.1.131.1.2345.1\n LOINCa\n 1152.128.2021\n 2.16.840.1.113883.6.1\n 34133-9\n InGen\n 34108-1\n 2012-02-17T00:00:00Z\n Summarization of episode note\n ^Smittya^Gerald^^^\n Redding Hospital\n 2.3.4.5\n \n \n Outpatient Evaluation And Management\n urn:oid:1.1.131.1.2345.1\n LOINCa\n 1152.128.7451\n 2.16.840.1.113883.6.1\n 34133-9\n InGen\n 34108-1\n 2012-02-17T00:00:00Z\n Summarization of episode note\n ^Smittya^Gerald^^^\n Redding Hospital\n 2.3.4.5\n \n \n Outpatient Evaluation And Management\n urn:oid:1.1.131.1.2345.1\n LOINCa\n 1152.128.2021\n 2.16.840.1.113883.6.1\n 34133-9\n InGen\n 34108-1\n 2012-02-17T00:00:00Z\n Summarization of episode note\n ^Smittya^Gerald^^^\n Redding Hospital\n 2.3.4.5\n \n \n Outpatient Evaluation And Management\n urn:oid:1.1.131.1.2345.1\n LOINCa\n 16379.23963.011\n 2.16.840.1.113883.6.1\n 34133-9\n InGen\n 34108-1\n 2012-02-17T00:00:00Z\n Summarization of episode note\n ^Smittya^Gerald^^^\n Redding Hospital\n 2.3.4.5\n \n \n \n \n \n" documentSearchCustomSuccessResponse: description: Document search custom response when the API is able to successfully fetch the document. value: "\n \n \n 1.2.3.131.1\n DaVita Hospital\n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n Medical Summary - Referral\n \n \n \n \n \n \n \n 12345 ROSE BOWL LN\n PASADENA\n CA\n 91104\n US\n \n \n \n \n ALPHA\n OPTUM\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n North Hollywood\n \n \n 6350 Laurel Canyon Blvd\n Suite 100\n North Hollywood\n CA\n 91606\n US\n \n \n \n \n \n \n \n \n \n \n \n \n North Hollywood\n \n \n 6350 Laurel Canyon Blvd\n Suite 100\n North Hollywood\n CA\n 91606\n US\n \n \n \n \n \n \n \n \n 6350 Laurel Canyon Blvd\n Suite 100\n North Hollywood\n CA\n 91606\n US\n \n \n \n North Hollywood\n \n \n 6350 Laurel Canyon Blvd\n Suite 100\n North Hollywood\n CA\n 91606\n US\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n 301 S FAIR OAKS AVE #101\n PASADENA\n \n 91105-2562\n US\n \n \n \n \n \n ANDREW\n MULLER\n M.D.\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n \n \n Reason for Referral\n No Reason for Referral was given.\n
\n \n \n
\n \n \n \n History of Present Illness\n No HPI available.\n
\n \n \n
\n \n \n \n \n \n Problems\n \n No current problems or disability.\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n
\n \n \n \n \n \n Medications\n \n No Active Medications\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n
\n \n \n \n \n \n Allergies and Adverse Reactions\n \n Not Known\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n Not Known\n \n \n \n \n \n \n \n
\n \n \n
\n \n \n \n \n Past Medical History\n \n No Significant Medical History.\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n
\n \n \n \n \n \n Results\n \n No Known Results\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n
\n \n \n \n \n \n Advance Directives\n \n No Advance Directives available.\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n ALPHA OPTUM\n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n
\n \n \n \n \n \n \n Encounters\n \n \n \n \n \n \n \n \n
\n \n AUDIT\n \n \n
\n \n 		\n On:\n 14-Mar-2019 2:55\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n
\n \n \n \n \n Insurance\n \n \n \n ALPHA OPTUM\n ; a guarantor\n \n \n HCPMG HCP SELF INSURED PLAN\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n AL\n \n US\n \n \n \n \n \n \n \n \n AL\n \n US\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n 12345 ROSE BOWL LN\n PASADENA\n CA\n 91104\n US\n \n \n \n \n ALPHA OPTUM\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n \n]]>\n \n \n \n \n" missingAuthorizationSection: description: Failed response due to missing the authorization section. value: "\n \n REQUEST_VALIDATION_ERROR\n 3219\n Authorization is not present.\n \n" userNotAssociated: description: Failed response due to user not having associated organizations. value: "\n \n REQUEST_VALIDATION_ERROR\n 3214\n Retrieved user is either null or does not have associated organizations.\n \n" invalidTenantOid: description: Failed response due to missing tenantOid in the authorization section. value: "\n \n REQUEST_VALIDATION_ERROR\n 3211\n Tenant OID not present.\n \n" invalidOrganizationId: description: Failed response due to missing the organization in the authorization section. value: "\n \n REQUEST_VALIDATION_ERROR\n 3213\n Organization ID not present.\n \n" invalidClientId: description: Failed response due to missing clienId in the authorization section. value: "\n \n REQUEST_VALIDATION_ERROR\n 3212\n Client ID(User ID/Optum ID) not present.\n \n" invalidPurposeOfUse: description: Failed response due to invalid purposeOfUse in the authorization section. value: "\n \n REQUEST_VALIDATION_ERROR\n 3218\n Purposeofuse is null or invalid.\n \n" missingPatientDemographics: description: Failed response due to missing the patient demographics section. value: "\n \n REQUEST_VALIDATION_ERROR\n 3230\n Patient demographics not present.\n \n" missingGivenSection: description: Failed response due to missing the patient demographics section. value: "\n \n REQUEST_VALIDATION_ERROR\n 3236\n Given section not present in document search request.\n \n" missingFamilyName: description: Failed response due to missing the family name in the patient demographics section. value: "\n \n REQUEST_VALIDATION_ERROR\n 3232\n Patient family(last) name is not present in the document search request.\n \n" missingFirstName: description: Failed response due to missing the first name in the patient demographics section. value: "\n \n REQUEST_VALIDATION_ERROR\n 3232\n Patient first name not present in document search request.\n \n" missingLivingSubjectBirthTime: description: Failed response due to missing birth information in the patient demographics section. value: "\n \n REQUEST_VALIDATION_ERROR\n 3233\n Patient date of birth is not present in the document search request.\n \n" missingLivingSubjectAdministrativeGender: description: Failed response due to missing the LivingSubjectAdministrativeGender information in the patient demographics section. value: "\n \n REQUEST_VALIDATION_ERROR\n 3234\n Patient gender is not present in the document search request.\n \n" invalidLivingSubjectAdministrativeGender: description: Failed response due to missing the gender information in the patient demographics section. value: "\n \n REQUEST_VALIDATION_ERROR\n 3238\n Invalid gender is received in the document search request.\n \n" '401': description: Response when the missing token/token is expired. content: application/json: schema: $ref: '#/components/schemas/HttpClientServerError' examples: missingToken: value: timestamp: '2023-11-10T22:53:39.611+00:00' status: 401 error: Missing token path: /xc-services/api/xc/v1/clinical/documents/search expiredToken: value: timestamp: '2023-11-10T22:53:39.611+00:00' status: 401 error: Token is expired path: /xc-services/api/xc/v1/clinical/documents/search '403': description: Response when forbidden access. content: application/json: schema: $ref: '#/components/schemas/HttpClientServerError' example: timestamp: '2023-11-10T22:53:39.611+00:00' status: 403 error: 'Forbidden: Missing service access' path: /xc-services/api/xc/v1/clinical/documents/search '404': description: Response when path is not found. content: application/json: schema: $ref: '#/components/schemas/HttpClientServerError' example: timestamp: '2023-11-10T22:53:39.611+00:00' status: 404 error: Not found path: /xc-services/api/xc/v1/clinical/documents/search1 '500': description: Response when an internal server error occurs. content: application/json: schema: $ref: '#/components/schemas/HttpClientServerError' examples: internalServerError: value: timestamp: '2023-11-10T22:53:39.611+00:00' status: 500 error: Internal Server Error path: /xc-services/api/xc/v1/clinical/documents/search '503': description: Response when service is not available. content: text/plain: schema: type: string example: no healthy upstream tags: - documentSearch components: schemas: SearchResults: type: object properties: result: type: array items: $ref: '#/components/schemas/Result' PrincipalCareProviderId: type: object properties: extension: type: string root: type: string assigningAuthorityName: type: string DeceasedTime: type: object properties: value: type: string Authorization: type: object required: - tenantOid - organizationId - clientId - purposeOfUse properties: purposeOfUse: type: string tenantOid: type: string subjectId: type: string role: type: string organizationId: type: string clientId: type: string clientUUId: type: string Address: type: object properties: postalCode: type: string streetAddressLine: type: string state: type: string use: type: string city: type: string country: type: string Documents: type: object properties: document: type: array items: $ref: '#/components/schemas/Document' DocumentSearchResponse: properties: searchResults: $ref: '#/components/schemas/SearchResults' responseStatus: $ref: '#/components/schemas/ResponseStatus' PatientInformation: type: object properties: id: type: array items: $ref: '#/components/schemas/Id' patientPerson: $ref: '#/components/schemas/PatientPerson' classCode: type: string Birthplace: type: object properties: place: $ref: '#/components/schemas/Place' LivingSubjectTelecommunication: type: array items: $ref: '#/components/schemas/Phone' LivingSubjectName: type: object properties: given: type: array items: $ref: '#/components/schemas/Given' family: type: string prefix: type: string use: type: string description: Supported values L, Null Flavor=NAV for, ASGN, A, I, C, ASGN, R, ASGN, Null Flavor=NAV, Null Flavor=UNK suffix: type: string ResponseStatus: type: object properties: responseState: type: string responseCode: type: string responseCodeDescription: type: string message: type: string PatientDemographics: type: object required: - livingSubjectName - livingSubjectBirthTime - livingSubjectAdministrativeGender properties: livingSubjectBirthPlaceName: type: string livingSubjectName: $ref: '#/components/schemas/LivingSubjectName' livingSubjectBirthTime: type: string livingSubjectAddress: $ref: '#/components/schemas/LivingSubjectAddress' livingSubjectBirthPlaceAddress: $ref: '#/components/schemas/Address' livingSubjectTelecommunication: $ref: '#/components/schemas/LivingSubjectTelecommunication' livingSubjectMothersMaidenName: type: string livingSubjectAdministrativeGender: type: string description: Supported values for LivingSubjectAdministrativeGender values can be M for male, F for female, UN for unknown, OTH for other, UNK for unknown. livingSubjectDeceasedTime: type: string livingSubjectId: type: array items: $ref: '#/components/schemas/LivingSubjectId' principalCareProviderId: $ref: '#/components/schemas/PrincipalCareProviderId' DocumentSearchRequest: type: object description: Request object model for document search. properties: authorization: $ref: '#/components/schemas/Authorization' patientDemographics: $ref: '#/components/schemas/PatientDemographics' additionalSearchParameters: $ref: '#/components/schemas/AdditionalSearchParameters' DocumentMetadataList: type: object properties: documentMetadata: type: array items: $ref: '#/components/schemas/DocumentMetadata' LivingSubjectAddress: type: array items: $ref: '#/components/schemas/Address' DocumentMetadata: type: object properties: authorInstitution: type: string authorPerson: type: string classCode: type: string classCodeDescription: type: string classCodeScheme: type: string creationTime: type: string format: date documentUniqueId: type: string homeCommunityId: type: string homeCommunityName: type: string format: string repositoryUniqueId: type: string typeCode: type: string typeCodeDescription: type: string typeCodeScheme: type: string AdministrativeGenderCode: type: object properties: code: type: string codeSystem: type: string codeSystemName: type: string codeSystemVersion: type: string displayName: type: string Document: type: object properties: payLoad: type: string Phone: type: object properties: value: type: string use: type: string description: 'Supported values for LivingSubjectAddress are: HP, H, WP, HV, AS, EC' HttpClientServerError: type: object properties: timestamp: type: string format: date status: type: integer error: type: string path: type: string Result: type: object properties: organizationId: type: string organizationName: type: string patientSearchResult: type: object properties: responseStatus: $ref: '#/components/schemas/ResponseStatus' patientInformation: $ref: '#/components/schemas/PatientInformation' documentSearchResult: type: object properties: responseStatus: $ref: '#/components/schemas/ResponseStatus' documentMetadataList: $ref: '#/components/schemas/DocumentMetadataList' documentList: $ref: '#/components/schemas/Documents' Given: type: object properties: name: type: string Name: type: object properties: use: type: array items: type: string given: type: array items: type: string family: type: string prefix: type: string sufix: type: string Telecom: type: object properties: value: type: string use: type: array items: type: string AdditionalSearchParameters: type: object properties: daysToSearchBack: type: string includeODD: type: string Addr: type: object properties: postalCode: type: string streetAddressLine: type: string state: type: string use: type: array items: type: string city: type: string country: type: string LivingSubjectId: type: object properties: extension: type: string root: type: string BirthTime: type: object properties: value: type: string Id: type: object properties: root: type: string extension: type: string assigningAuthorityName: type: string PatientPerson: type: object properties: birthplace: $ref: '#/components/schemas/Birthplace' name: type: array items: $ref: '#/components/schemas/Name' telecom: type: array items: $ref: '#/components/schemas/Telecom' administrativeGenderCode: $ref: '#/components/schemas/AdministrativeGenderCode' addr: type: array items: $ref: '#/components/schemas/Addr' birthTime: $ref: '#/components/schemas/BirthTime' deceasedTime: $ref: '#/components/schemas/DeceasedTime' Place: type: object properties: placeName: type: string addr: $ref: '#/components/schemas/Addr' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT x-readme: explorer-enabled: true proxy-enabled: true