openapi: 3.2.0
info:
  title: Predoc Partner Patient API
  description: API for the Predoc platform to allow partners to request the retrieval of patient records.
  version: '1.1'
  contact: {}
servers:
- url: https://partner-api-stage.predoc.ai/api
tags:
- name: Patient
  description: ''
paths:
  /v1/patients:
    get:
      description: '> **Deprecated:** Supplying search criteria in the request body will be removed in a future release. Use query parameters instead.


        Searches for patients using the supplied demographic criteria. Returned patient IDs can be used with `GET /patients/{patientId}` to retrieve complete patient information. If no patient matches, the response contains an empty patient ID and an explanatory message.'
      operationId: PatientController_searchPatientsByInformation_v1
      parameters:
      - name: patientKey
        required: false
        in: query
        description: Patient Key.
        schema:
          minLength: 17
          maxLength: 17
          example: PAPI-123456789012
          type: string
      - name: firstName
        required: false
        in: query
        description: First name of the patient.
        schema:
          minLength: 2
          maxLength: 45
          example: Martha
          type: string
      - name: lastName
        required: false
        in: query
        description: Last name of the patient.
        schema:
          minLength: 2
          maxLength: 60
          example: Rangel
          type: string
      - name: phoneNumber
        required: false
        in: query
        description: Phone number of the patient, digits only.
        schema:
          minLength: 10
          maxLength: 10
          example: '7175501675'
          type: string
      - name: dateOfBirth
        required: false
        in: query
        description: Date of birth of the patient, in `YYYY-MM-DD` format.
        schema:
          format: date-time
          example: '1970-03-10'
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatientSearchBodyInput'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PatientInfoResponseDto'
      security:
      - bearer: []
      summary: Search Patients by Information
      tags:
      - Patient
  /v1/patients/{patientId}:
    get:
      description: Gets the full information for the specified patient. If no patient is found with the corresponding ID, a 404 error will be returned.
      operationId: PatientController_getPatientInformation_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientInfoResponseDto'
      security:
      - bearer: []
      summary: Get Patient Information
      tags:
      - Patient
    patch:
      description: Updates patient information while the patient is in an `Open` status. If any request for the patient has progressed beyond `Open`, the patient information is locked and cannot be updated. When an update is not allowed, the standard response object explains why.
      operationId: PatientController_updatePatientInformation_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePatientInformationInpDto'
      responses:
        '200':
          description: The patient information was handled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePatientInformationRespDto'
      security:
      - bearer: []
      summary: Update Patient Information
      tags:
      - Patient
  /v1/patients/{patientId}/additional-records:
    get:
      description: Gets a list of additional records for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received.
      operationId: PatientDocumentsController_getPatientAdditionalRecords_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientAdditionalRecordsDto'
      security:
      - bearer: []
      summary: Get Patient Additional Records
      tags:
      - Patient
  /v1/patients/{patientId}/curated-patient-data/{classificationGroupType}:
    get:
      description: 'Returns curated patient data for one classification group. The response schema is selected by `classificationGroupType` and identified by the matching discriminator in the response body. Partner-facing display text is returned without literal `|` separators, while identifiers, patient keys, URLs, source metadata, codes, statuses, dates, timestamps, and contact fields are preserved as received.


        ### Availability


        Curated Data availability depends on your Predoc contract. Use this endpoint when structured clinical data is included in your workflow; otherwise, use the document endpoints to retrieve patient records in their original formats. Contact your account manager if you are unsure which endpoints are enabled for your organization.'
      operationId: CuratedPatientDataController_getCuratedPatientData_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          type: string
      - name: classificationGroupType
        required: true
        in: path
        description: Curated patient data classification group to retrieve.
        schema:
          type: string
          enum:
          - allergies
          - demographics
          - encounters
          - family-history
          - imaging-notes
          - labs
          - medications
          - other
          - pathology-results
          - problems
          - procedure-notes
          - procedures
          - provider-facility-notes
          - providers
          - social-history
          - vaccinations
          - vitals
      responses:
        '200':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/AllergiesResponseDto'
                - $ref: '#/components/schemas/DemographicsResponseDto'
                - $ref: '#/components/schemas/EncountersResponseDto'
                - $ref: '#/components/schemas/ProblemsResponseDto'
                - $ref: '#/components/schemas/ImagingNotesResponseDto'
                - $ref: '#/components/schemas/LabsResponseDto'
                - $ref: '#/components/schemas/MedicationsResponseDto'
                - $ref: '#/components/schemas/OtherResponseDto'
                - $ref: '#/components/schemas/PathologyResultsResponseDto'
                - $ref: '#/components/schemas/ProceduresResponseDto'
                - $ref: '#/components/schemas/ProcedureNotesResponseDto'
                - $ref: '#/components/schemas/VaccinationsResponseDto'
                - $ref: '#/components/schemas/FamilyHistoryResponseDto'
                - $ref: '#/components/schemas/ProviderFacilityNotesResponseDto'
                - $ref: '#/components/schemas/ProvidersResponseDto'
                - $ref: '#/components/schemas/SocialHistoryResponseDto'
                - $ref: '#/components/schemas/VitalsResponseDto'
                discriminator:
                  propertyName: classificationGroupType
                  mapping:
                    allergies: '#/components/schemas/AllergiesResponseDto'
                    demographics: '#/components/schemas/DemographicsResponseDto'
                    encounters: '#/components/schemas/EncountersResponseDto'
                    problems: '#/components/schemas/ProblemsResponseDto'
                    imaging-notes: '#/components/schemas/ImagingNotesResponseDto'
                    labs: '#/components/schemas/LabsResponseDto'
                    medications: '#/components/schemas/MedicationsResponseDto'
                    other: '#/components/schemas/OtherResponseDto'
                    pathology-results: '#/components/schemas/PathologyResultsResponseDto'
                    procedures: '#/components/schemas/ProceduresResponseDto'
                    procedure-notes: '#/components/schemas/ProcedureNotesResponseDto'
                    vaccinations: '#/components/schemas/VaccinationsResponseDto'
                    family-history: '#/components/schemas/FamilyHistoryResponseDto'
                    provider-facility-notes: '#/components/schemas/ProviderFacilityNotesResponseDto'
                    providers: '#/components/schemas/ProvidersResponseDto'
                    social-history: '#/components/schemas/SocialHistoryResponseDto'
                    vitals: '#/components/schemas/VitalsResponseDto'
              examples:
                allergies:
                  summary: Allergies Response
                  value:
                    classificationGroupType: allergies
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      allergyId: allergy-1
                      practitionerRoleId: practitioner-role-1
                      allergyCodes:
                      - '91935009'
                      name: Peanuts
                      recordedDate: '2024-01-20'
                      onsetStartDate: '2024-01-15'
                      onsetEndDate: null
                      reactionManifestation: anaphylaxis
                      reactionManifestationCodes:
                      - '39579001'
                      sources:
                      - source: HIE
                        retrievalDate: '2026-04-01'
                demographics:
                  summary: Demographics Response
                  value:
                    classificationGroupType: demographics
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      givenName: Jane
                      familyName: Patient
                      dateOfBirth: '1980-01-01'
                      middleName: Q
                      gender: female
                      maritalStatus: married
                      race:
                      - Asian
                      language: en
                      telephones:
                      - '9735550100'
                      emails:
                      - jane.patient@example.com
                      addressLine1: 50 Pompton Ave
                      addressLine2: null
                      city: Verona
                      state: NJ
                      county: Essex
                      postalCode: '07044'
                      patientCountry: US
                      socialNumber: null
                      sources:
                      - source: provider-facility
                        retrievalDate: '2026-04-01'
                        documentId: b95793ce-321b-45f1-92cb-06743e3ddef9
                        documentUrl: https://documents.example/source.pdf
                encounters:
                  summary: Encounters Response
                  value:
                    classificationGroupType: encounters
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      encounterId: encounter-1
                      startTime: '2026-03-18T09:15:00Z'
                      endTime: '2026-03-18T11:45:00Z'
                      encounterTypeCodes:
                      - code: IMP
                        codeSystem: http://terminology.hl7.org/CodeSystem/v3-ActCode
                        display: Inpatient encounter
                        name: null
                      typeName: Hospital encounter
                      hospitalizationDischargeDisposition: Home or self care
                      conditionIdReferences:
                      - condition-1
                      locationIdReferences:
                      - location-1
                      practitionerRoleIdReferences:
                      - practitioner-role-1
                      encounterText: Encounter summary text.
                      conditions:
                      - conditionName: Hypertension
                        conditionOnsetDate: '2024-01-15'
                        conditionRecordedDate: '2024-01-20'
                        conditionClinicalStatus: active
                        conditionCategoryCodeName: Problem List Item
                        conditionText: Controlled on medication
                      locations:
                      - name: Verona Clinic
                        locationType: clinic
                        addressUse: work
                        address: 50 Pompton Ave
                        city: Verona
                        state: NJ
                        postalCode: '07044'
                      practitioners:
                      - referenceId: practitioner-role-1
                        givenName: Jane
                        familyName: Smith
                        addressStreet: 50 Pompton Ave
                        addressCity: Verona
                        addressState: NJ
                        addressUse: work
                        roleSpecialty: Internal Medicine
                        role: Attending
                        telecoms:
                        - '9735550100'
                      documentReferences:
                      - referenceType: encounter
                        contentType: application/pdf
                        documentMetadata:
                          key: curated/encounter-1.pdf
                          ctype: application/pdf
                          bucket: documents
                          docId: doc-1
                          checksum: checksum
                          encoding: utf-8
                          signedUrl: https://documents.example/encounter-1.pdf
                      sources:
                      - source: HIE
                        retrievalDate: '2026-04-01'
                problems:
                  summary: Problems Response
                  value:
                    classificationGroupType: problems
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      conditionId: condition-1
                      encounterId: encounter-1
                      problemCodes:
                      - '38341003'
                      name: Hypertension
                      onsetDate: '2024-01-15'
                      categoryCodes:
                      - problem-list-item
                      clinicalStatus: active
                      categoryCodeName: Problem List Item
                      conditionNote: Controlled on medication
                      resolutionDate: null
                      recordedDate: '2024-01-20'
                      sources:
                      - source: HIE
                        retrievalDate: '2026-04-01'
                imagingNotes:
                  summary: Imaging Notes Response
                  value:
                    classificationGroupType: imaging-notes
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      imagingNoteId: imaging-note-1
                      imagingNoteName: Chest X-Ray
                      imagingType: X-Ray
                      bodyPart: Chest
                      date: '2024-01-20'
                      notes: No acute findings.
                      requestInitialProcessedAt: '2026-03-01T12:00:00Z'
                      requestLastProcessedAt: '2026-03-03T12:00:00Z'
                      sources:
                      - source: provider-facility
                        retrievalDate: '2026-04-01'
                        documentId: b95793ce-321b-45f1-92cb-06743e3ddef9
                        documentUrl: https://documents.example/source.pdf
                labs:
                  summary: Labs Response
                  value:
                    classificationGroupType: labs
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      labId: lab-1
                      name: White Blood Cell Count
                      labCodes:
                      - 6690-2
                      value: '4.1'
                      unit: 10^3/uL
                      observationCategory: laboratory
                      diagnosticReportName: Complete Blood Count
                      recordedDatetime: '2026-03-18T09:15:00Z'
                      interpretation: normal
                      labText: White blood cells
                      performerPractitionerRoleIdReferences:
                      - performer-role-1
                      interpreterPractitionerRoleIdReferences:
                      - interpreter-role-1
                      sources:
                      - source: HIE
                        retrievalDate: '2026-04-01'
                medications:
                  summary: Medications Response
                  value:
                    classificationGroupType: medications
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      medicationId: medication-1
                      medicationCodes:
                      - '314076'
                      name: Lisinopril 10 MG Oral Tablet
                      practitionerRoleId: practitioner-role-1
                      statementId: statement-1
                      statementText: Take 1 tablet by mouth daily.
                      status: active
                      startDatetime: '2024-01-15T09:00:00Z'
                      endDatetime: null
                      doseValue: '10'
                      doseUnit: mg
                      doseRoute: oral
                      patientInstructions: Take with water.
                      sources:
                      - source: HIE
                        retrievalDate: '2026-04-01'
                    - patientId: 11111111-1111-4111-8111-111111111111
                      medicationId: medication-2
                      medicationCodes:
                      - '617314'
                      name: Atorvastatin 20 MG Oral Tablet
                      practitionerRoleId: null
                      statementId: statement-2
                      statementText: Take 1 tablet by mouth at bedtime.
                      status: active
                      startDatetime: '2024-02-10T21:00:00Z'
                      endDatetime: null
                      doseValue: '20'
                      doseUnit: mg
                      doseRoute: oral
                      patientInstructions: Take at night.
                      sources:
                      - source: Surescripts
                        retrievalDate: '2026-04-02'
                    - patientId: 11111111-1111-4111-8111-111111111111
                      medicationId: medication-3
                      medicationCodes:
                      - '860975'
                      name: Metformin 500 MG Oral Tablet
                      practitionerRoleId: practitioner-role-2
                      statementId: statement-3
                      statementText: Take 1 tablet by mouth twice daily.
                      status: active
                      startDatetime: '2024-03-01T08:00:00Z'
                      endDatetime: null
                      doseValue: '500'
                      doseUnit: mg
                      doseRoute: oral
                      patientInstructions: Take with meals.
                      sources:
                      - source: provider-facility
                        retrievalDate: '2026-04-01'
                        documentId: b95793ce-321b-45f1-92cb-06743e3ddef9
                        documentUrl: https://documents.example/source.pdf
                other:
                  summary: Other Response
                  value:
                    classificationGroupType: other
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      otherId: other-1
                      title: Referral cover sheet
                      date: '2024-01-20'
                      requestInitialProcessedAt: '2026-03-01T12:00:00Z'
                      requestLastProcessedAt: '2026-03-03T12:00:00Z'
                      sources:
                      - source: provider-facility
                        retrievalDate: '2026-04-01'
                        documentId: b95793ce-321b-45f1-92cb-06743e3ddef9
                        documentUrl: https://documents.example/source.pdf
                pathologyResults:
                  summary: Pathology Results Response
                  value:
                    classificationGroupType: pathology-results
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      pathologyResultId: pathology-result-1
                      pathologyName: Biopsy
                      diagnosis: Benign
                      specimenSource: Skin
                      date: '2024-01-20'
                      requestInitialProcessedAt: '2026-03-01T12:00:00Z'
                      requestLastProcessedAt: '2026-03-03T12:00:00Z'
                      sources:
                      - source: provider-facility
                        retrievalDate: '2026-04-01'
                        documentId: b95793ce-321b-45f1-92cb-06743e3ddef9
                        documentUrl: https://documents.example/source.pdf
                procedures:
                  summary: Procedures Response
                  value:
                    classificationGroupType: procedures
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      procedureId: procedure-1
                      encounterId: encounter-1
                      procedureCodes:
                      - '80146002'
                      name: Appendectomy
                      procedureNote: Procedure completed without complications.
                      procedureDatetime: '2024-02-01T14:30:00Z'
                      asserterPractitionerRoleId: asserter-role-1
                      performerPractitionerRoleId: performer-role-1
                      reason: Abdominal pain
                      reasonCodes:
                      - '21522001'
                      sources:
                      - source: HIE
                        retrievalDate: '2026-04-01'
                procedureNotes:
                  summary: Procedure Notes Response
                  value:
                    classificationGroupType: procedure-notes
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      procedureNoteId: procedure-note-1
                      procedureName: Colonoscopy
                      dateOfProcedure: '2024-02-01'
                      notes: Procedure completed without complications.
                      providerFirstName: Jane
                      providerLastName: Smith
                      providerType: Gastroenterology
                      professionalDesignation1: MD
                      professionalDesignation2: null
                      professionalDesignation3: null
                      requestInitialProcessedAt: '2026-03-01T12:00:00Z'
                      requestLastProcessedAt: '2026-03-03T12:00:00Z'
                      sources:
                      - source: provider-facility
                        retrievalDate: '2026-04-01'
                        documentId: b95793ce-321b-45f1-92cb-06743e3ddef9
                        documentUrl: https://documents.example/source.pdf
                vaccinations:
                  summary: Vaccinations Response
                  value:
                    classificationGroupType: vaccinations
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      immunizationId: immunization-1
                      immunizationCodes:
                      - '207'
                      name: COVID-19 vaccine
                      route: Intramuscular
                      status: completed
                      routeCodes:
                      - IM
                      dosageUnit: mL
                      dosageValue: '0.3'
                      occurrenceTime: '2024-03-10T10:00:00Z'
                      siteCodes:
                      - LA
                      site: Left arm
                      sources:
                      - source: HIE
                        retrievalDate: '2026-04-01'
                familyHistory:
                  summary: Family History Response
                  value:
                    classificationGroupType: family-history
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      familyMemberHistoryId: family-history-1
                      sexCodes:
                      - M
                      sexDisplay: Male
                      conditionCodes:
                      - '44054006'
                      conditionDisplay: Diabetes mellitus type 2
                      relationshipCodes:
                      - FTH
                      relationshipDisplay: Father
                      notes: Diagnosed in adulthood.
                      sources:
                      - source: HIE
                        retrievalDate: '2026-04-01'
                providerFacilityNotes:
                  summary: Provider Facility Notes Response
                  value:
                    classificationGroupType: provider-facility-notes
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      providerFacilityNoteId: provider-facility-note-1
                      facilityName: Verona Clinic
                      noteTitle: Consult Note
                      notes: Follow up in six months.
                      providerFirstName: Jane
                      providerLastName: Smith
                      providerFacilityType: clinic
                      professionalDesignation1: MD
                      professionalDesignation2: null
                      professionalDesignation3: null
                      serviceStartDate: '2024-02-01'
                      serviceEndDate: '2024-02-01'
                      requestInitialProcessedAt: '2026-03-01T12:00:00Z'
                      requestLastProcessedAt: '2026-03-03T12:00:00Z'
                      sources:
                      - source: provider-facility
                        retrievalDate: '2026-04-01'
                        documentId: b95793ce-321b-45f1-92cb-06743e3ddef9
                        documentUrl: https://documents.example/source.pdf
                providers:
                  summary: Providers Response
                  value:
                    classificationGroupType: providers
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      providerId: provider-1
                      firstName: Jane
                      lastName: Smith
                      npi: '1234567890'
                      specialty: Internal Medicine
                      professionalDesignation1: MD
                      professionalDesignation2: null
                      professionalDesignation3: null
                      street1: 50 Pompton Ave
                      street2: null
                      city: Verona
                      state: NJ
                      postalCode: '07044'
                      phoneNumber: '9735550100'
                      faxNumber: '9735550101'
                      email: provider@example.com
                      requestInitialProcessedAt: '2026-03-01T12:00:00Z'
                      requestLastProcessedAt: '2026-03-03T12:00:00Z'
                      sources:
                      - source: HIE
                        retrievalDate: '2026-04-01'
                socialHistory:
                  summary: Social History Response
                  value:
                    classificationGroupType: social-history
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      socialHistoryId: social-history-1
                      practitionerRoleId: practitioner-role-1
                      socialHistoryText: Former smoker.
                      category: social-history
                      socialHistoryCodes:
                      - '8517006'
                      name: Tobacco smoking status
                      observationTimestamp: '2024-01-20T10:00:00Z'
                      value: Former smoker
                      valueCodes:
                      - '8517006'
                      sources:
                      - source: HIE
                        retrievalDate: '2026-04-01'
                vitals:
                  summary: Vitals Response
                  value:
                    classificationGroupType: vitals
                    partnerPatientId: 11111111-1111-4111-8111-111111111111
                    patientKey: patient-key-123
                    items:
                    - patientId: 11111111-1111-4111-8111-111111111111
                      vitalSignId: height
                      observationCategory: vital-signs
                      vitalSignCodes:
                      - 8302-2
                      observationName: Height
                      observationText: Height observation
                      observationDatetime: '2026-03-18T09:15:00Z'
                      observationUnit: cm
                      observationValue: '180'
                      groupingObservationId: observation-group-1
                      sources:
                      - source: HIE
                        retrievalDate: '2026-04-01'
          description: ''
      security:
      - bearer: []
      summary: Get Curated Patient Data
      tags:
      - Patient
  /v1/patients/{patientId}/documents:
    get:
      description: Gets a list of documents for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received.
      operationId: PatientDocumentsController_getPatientDocuments_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientDocumentsDto'
      security:
      - bearer: []
      summary: Get Patient Documents
      tags:
      - Patient
  /v1/patients/{patientId}/drug-allergies:
    get:
      description: Gets a list of drug allergies for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received.
      operationId: PatientDocumentsController_getPatientDrugAllergies_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientDrugAllergiesDto'
      security:
      - bearer: []
      summary: Get Patient Drug Allergies
      tags:
      - Patient
  /v1/patients/{patientId}/facesheets:
    get:
      description: Gets a list of facesheets for the patient by ID. Facesheets with structured output include a `requestId` for retrieving that output, and their `images` contain the all-referenced-records PDF when available. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received.
      operationId: PatientDocumentsController_getPatientFacesheets_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientFacesheetsDto'
      security:
      - bearer: []
      summary: Get Patient Facesheets
      tags:
      - Patient
  /v1/patients/{patientId}/facesheets/requests/{facesheetRequestId}/output:
    get:
      description: Returns the finalized facesheet questions, answers, rationale, and source references. Partner-facing display text is returned without literal `|` separators, while identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received.
      operationId: PatientDocumentsController_getPatientFacesheetOutput_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      - name: facesheetRequestId
        required: true
        in: path
        description: Unique identifier of the facesheet request.
        schema:
          format: uuid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientFacesheetOutputDto'
      security:
      - bearer: []
      summary: Get Patient Facesheet Output
      tags:
      - Patient
  /v1/patients/{patientId}/hie-docs:
    get:
      description: Gets a list of HIE documents for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received.
      operationId: PatientDocumentsController_getPatientHieDocs_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientHieDocsDto'
      security:
      - bearer: []
      summary: Get Patient HIE documents
      tags:
      - Patient
  /v1/patients/{patientId}/imaging-results:
    get:
      description: Gets a list of imaging results for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received.
      operationId: PatientDocumentsController_getPatientImagingResults_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientImagingResultsDto'
      security:
      - bearer: []
      summary: Get Patient Imaging Results
      tags:
      - Patient
  /v1/patients/{patientId}/lab-results:
    get:
      description: 'NOTE: Body usage is deprecated and will be removed in a future release. Please use query params instead. Gets the specified lab result values for the requested patient. If no criteria are provided, all results on the patient profile will be returned. The list of available labs can be retrieved via the `/patients/{patientId}/lab-results/available` endpoint. Literal `|` separators are removed from returned lab display text and ignored when matching `searchChemistries`.'
      operationId: PatientController_getPatientLabResultsBySearch_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          type: string
      - name: searchChemistries
        required: false
        in: query
        description: List of lab result names to search for. Literal `|` separators are ignored during matching so values returned from `/patients/{patientId}/lab-results/available` can be used directly.
        schema:
          type: array
          items:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatientLabResultsSearchBodyInput'
      responses:
        '200':
          description: The lab results for the patient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientLabResultSearchRespDto'
      security:
      - bearer: []
      summary: Patient Lab Results
      tags:
      - Patient
  /v1/patients/{patientId}/lab-results/available:
    get:
      description: Gets all of the available lab result chemistries for the requested patient. Literal `|` separators are removed from these partner-facing display values. This endpoint can be used in conjunction with the `/patients/{patientId}/lab-results` endpoint to retrieve the available lab results for the patient.
      operationId: PatientController_getAvailablePatientChemistries_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          type: string
      responses:
        '200':
          description: The available lab results for the patient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientAvailableChemRespDto'
      security:
      - bearer: []
      summary: Available Patient Lab Results
      tags:
      - Patient
  /v1/patients/{patientId}/lab-tests:
    get:
      description: Gets a list of lab tests for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received.
      operationId: PatientDocumentsController_getPatientLabTests_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      - name: includeResults
        required: false
        in: query
        description: Whether to include lab test results in the response.
        schema:
          default: true
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientLabTestResultsDto'
      security:
      - bearer: []
      summary: Get Patient Lab Tests
      tags:
      - Patient
  /v1/patients/{patientId}/medications:
    get:
      description: Gets a list of medications for the patient by ID.
      operationId: PatientDocumentsController_getPatientMedications_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientMedicationsDto'
      security:
      - bearer: []
      summary: Get Patient Medications
      tags:
      - Patient
  /v1/patients/{patientId}/other-records:
    get:
      description: Gets a list of other records for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received.
      operationId: PatientDocumentsController_getPatientOtherRecords_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientOtherRecordsDto'
      security:
      - bearer: []
      summary: Get Patient Other Records
      tags:
      - Patient
  /v1/patients/{patientId}/procedure-notes:
    get:
      description: Gets a list of procedure notes for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received.
      operationId: PatientDocumentsController_getPatientProcedureNotes_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientProcedureNotesDto'
      security:
      - bearer: []
      summary: Get Patient Procedure Notes
      tags:
      - Patient
  /v1/patients/{patientId}/provider-notes:
    get:
      description: Gets a list of provider/facility notes for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received.
      operationId: PatientDocumentsController_getPatientProviderFacilityNotes_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientProviderFacilityNotesDto'
      security:
      - bearer: []
      summary: Get Patient Provider Facility Notes
      tags:
      - Patient
  /v1/patients/{patientId}/requests:
    get:
      description: Returns all requests for the patient, regardless of status, so the organization can track each request’s progress.
      operationId: PatientController_getPatientRequests_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          type: string
      responses:
        '200':
          description: All available patient requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientRequestsResponseDto'
      security:
      - bearer: []
      summary: Patient Requests
      tags:
      - Patient
    post:
      description: Creates a record-retrieval request for an existing patient. The request initially has a `Creating` status and remains editable until it progresses beyond `Open`. The response includes the request ID for use with other endpoints.
      operationId: PatientController_addRequestToExistingPatient_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCrrInpDto'
      responses:
        '201':
          description: The request was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordRequestRespDto'
      security:
      - bearer: []
      summary: Add Request to Existing Patient
      tags:
      - Patient
  /v1/patients/{patientId}/summary:
    post:
      description: 'Creates a clinical-summary document request for the specified patient.


        Use the returned `patientSummaryRequestId` with `GET /documents/{documentId}` to check processing status and retrieve the completed document.


        Source documents are selected only by the requested categories and date range. The organization’s document-set delivery mode does not filter clinical-summary source documents.'
      operationId: PatientController_requestPatientClinicalSummary_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestClinicalSummaryInpDto'
      responses:
        '201':
          description: The request was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientSummaryResDto'
      security:
      - bearer: []
      summary: Request Patient Clinical Summary
      tags:
      - Patient
  /v1/patients/{patientId}/vaccine-documents:
    get:
      description: Gets a list of vaccine and immunization documents for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received.
      operationId: PatientDocumentsController_getPatientVaccineDocuments_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientVaccineDocumentsDto'
      security:
      - bearer: []
      summary: Get Patient Vaccines & Immunization Documents
      tags:
      - Patient
  /v1/patients/{patientId}/vaccine-records:
    get:
      description: Gets a list of vaccine and immunization records for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received.
      operationId: PatientDocumentsController_getPatientVaccineRecords_v1
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          format: uuid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientVaccineRecordsDto'
      security:
      - bearer: []
      summary: Get Patient Vaccine & Immunization Records
      tags:
      - Patient
  /v2/patients:
    post:
      description: Creates a new patient without a record request.
      operationId: PatientController_createPatient_v2
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePatientV2InpDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePatientRespDto'
      security:
      - bearer: []
      summary: Create Patient
      tags:
      - Patient
  /v2/patients/{patientId}/documents/search:
    post:
      description: 'Searches the patient’s available documents using the supplied criteria. Results follow the organization’s document-set delivery mode: `CANVAS_SET` includes `CANVAS_SET`, `PRESPLICED`, and untagged historical records; `SEGMENT_SET` includes `SEGMENT_SET`, `PRESPLICED`, and untagged historical records. If no mode is configured, `CANVAS_SET` behavior applies. Partner-facing display text is returned without literal `|` separators, while identifiers, URLs, categories, dates, and splice metadata are preserved as received.'
      operationId: PatientController_searchPatientDocuments_v2
      parameters:
      - name: patientId
        required: true
        in: path
        description: Unique identifier of the patient.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatientDocumentSearchInpDto'
      responses:
        '200':
          description: The matching documents for the patient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientDocumentSearchRespDto'
      security:
      - bearer: []
      summary: Search Patient Documents
      tags:
      - Patient
components:
  schemas:
    EncounterTypeCodeDto:
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
        codeSystem:
          type:
          - string
          - 'null'
        display:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
      required:
      - code
      - codeSystem
      - display
      - name
    PreviousProviderInpDto:
      type: object
      properties:
        orgName:
          type: string
          description: Full name of the organization provider. This is only required when `providerFirstName` and `providerLastName` are not used.
        providerFirstName:
          type: string
          description: First name of the provider. This is only required when `orgName` is not used.
        providerLastName:
          type: string
          description: Last name of the provider. This is only required when `orgName` is not used.
        practiceName:
          type: string
          description: Provider's practice name.
        orgAddress:
          description: Physical address of the organization's provider.
          allOf:
          - $ref: '#/components/schemas/AddressPreviousProviderInpDto'
        orgPhoneCountryCode:
          type: string
          default: '+1'
          deprecated: true
          description: Country code of the organization's phone number with a + at the beginning.
          example: '+1'
        orgPhoneNumber:
          type: string
          description: Phone number of the organization, with no special characters (digits only).
          example: '5553643856'
        orgFaxNumber:
          type: string
          description: Fax number of the organization, with no special characters (digits only).
          example: '5553643856'
        datesOfService:
          description: Date range of when the organization provided care to the patient.
          allOf:
          - $ref: '#/components/schemas/RequestDatesOfServiceInpDto'
        specificMedicalRecordRequested:
          type: string
          description: Type of custom document requested, if necessary.
          example: oncology
      required:
      - orgName
      - providerFirstName
      - providerLastName
      - datesOfService
    PatientAdditionalRecordsDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        additionalRecords:
          description: List of additional records for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/AdditionalRecordDto'
      required:
      - partnerPatientId
      - additionalRecords
    ProviderFacilityNotesResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - provider-facility-notes
        items:
          type: array
          items:
            $ref: '#/components/schemas/ProviderFacilityNoteItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    LabTestDocumentUrlDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the lab test document.
          format: uuid
        url:
          type: string
          description: Signed URL to access the lab test document.
          format: url
          example: https://example.com/document.pdf
        createdAt:
          format: date-time
          type: string
          description: Date and time when the lab test document was first created.
      required:
      - id
      - url
    VitalsResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - vitals
        items:
          type: array
          items:
            $ref: '#/components/schemas/VitalItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    PatientInfoResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Unique identifier for the patient.
          format: uuid
        patientKey:
          type: string
          description: Yet another unique identifier for the patient.
          example: PAPI-123456789012
        firstName:
          type: string
          description: First name of the patient.
          example: Martha
        middleName:
          type: string
          description: Middle name of the patient.
          example: Sara
        lastName:
          type: string
          description: Last name of the patient.
          example: Rangel
        genderName:
          type: string
          description: Gender of the patient.
          example: female
        dateOfBirth:
          type: string
          description: Date of birth of the patient.
          example: '1970-03-10'
        phoneNumber:
          type: string
          description: Phone number of the patient, without spaces or dashes.
          example: '7175501675'
        addressLine1:
          type: string
          description: Address line 1 of the patient address.
          example: 4990 HOOVER RD
        addressLine2:
          type: string
          description: Address line 2 of the patient address.
          example: APT 227
        city:
          type: string
          description: City of the patient address.
          example: GROVE CITY
        state:
          type: string
          description: State of the patient address.
          example: OH
        postalCode:
          type: string
          description: Postal code of the patient address. 5 digits
          example: '43123'
        primaryLanguage:
          type: string
          description: Primary language of the patient.
          example: english
      required:
      - partnerPatientId
      - patientKey
      - firstName
      - middleName
      - lastName
      - genderName
      - dateOfBirth
      - phoneNumber
      - addressLine1
      - addressLine2
      - city
      - state
      - postalCode
      - primaryLanguage
    DocumentDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the document.
          format: uuid
        title:
          type: string
          description: Title of the document. Literal `|` separators are removed from this partner-facing display text.
          example: Discharge Summary
        comments:
          type: string
          description: Comments on the document. Literal `|` separators are removed from this partner-facing display text.
          example: Reviewed by provider
        date:
          type: string
          description: Document date.
        createdAt:
          format: date-time
          type: string
          description: Date the document was created.
        images:
          description: Document URLs for the document. These can be used to download the document information.
          type: array
          items:
            $ref: '#/components/schemas/DocumentUrlDto'
        documentType:
          type:
          - string
          - 'null'
          description: Document type/category when provided by the upstream service. Literal `|` separators are removed from this partner-facing display text. If the document type is missing or blank, this field is null.
          example: CONSENT AND AUTHORIZATION FORMS
        indexedRecordSpliceType:
          type:
          - string
          - 'null'
          description: Spliced indexed record classification. Null means no splice metadata is available for the document.
          enum:
          - CANVAS_SET
          - SEGMENT_SET
          - PRESPLICED
      required:
      - id
      - title
      - comments
      - date
      - createdAt
      - images
      - documentType
      - indexedRecordSpliceType
    VaccineDocumentVaccineDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the vaccine.
          format: uuid
        type:
          description: Vaccine type information.
          allOf:
          - $ref: '#/components/schemas/VaccineTypeDto'
        alternateName:
          type:
          - string
          - 'null'
          description: Alternate name for the vaccine, which may be more widely-used.
          example: someOtherVaccine
        date:
          type: string
          description: Date the vaccine was administered.
          format: date
        comments:
          type: string
          description: Comments on the vaccine.
          example: The quick brown fox jumps over the lazy dog.
      required:
      - id
      - date
      - comments
    VaccineDocumentDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the vaccine document.
          format: uuid
        createdAt:
          format: date-time
          type: string
          description: Date the vaccine document was created.
        images:
          description: Document URLs for the vaccine document. These can be used to download the images.
          type: array
          items:
            $ref: '#/components/schemas/VaccineDocumentUrlDto'
        indexedRecordSpliceType:
          type:
          - string
          - 'null'
          description: Spliced indexed record classification. Null means no splice metadata is available for the vaccine document.
          enum:
          - CANVAS_SET
          - SEGMENT_SET
          - PRESPLICED
        vaccines:
          description: Vaccines and immunizations contained within this document.
          type: array
          items:
            $ref: '#/components/schemas/VaccineDocumentVaccineDto'
      required:
      - id
      - createdAt
      - images
      - indexedRecordSpliceType
      - vaccines
    PatientFacesheetOutputDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        facesheet:
          $ref: '#/components/schemas/FacesheetOutputDto'
      required:
      - partnerPatientId
      - facesheet
    ImagingTypeDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the imaging type.
          format: uuid
        name:
          type: string
          description: Type name for the imaging process. This is not the name of the image, but the type of image. Literal `|` separators are removed from this partner-facing display text.
          example: xray
        displayName:
          type: string
          description: Display name for the imaging type. This is a more user-friendly name. Literal `|` separators are removed from this partner-facing display text.
          example: X-Ray
      required:
      - id
      - name
      - displayName
    ImagingResultDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the imaging result.
          format: uuid
        type:
          description: Imaging type information.
          allOf:
          - $ref: '#/components/schemas/ImagingTypeDto'
        bodyPart:
          description: Body part that was imaged.
          allOf:
          - $ref: '#/components/schemas/BodyPartDto'
        alternateBodyPartName:
          type: string
          description: Alternate name for the body part that was imaged. Literal `|` separators are removed from this partner-facing display text.
          example: clavicle
        title:
          type: string
          description: Title of the imaging result. Literal `|` separators are removed from this partner-facing display text.
          example: X-Ray Results
        date:
          type: string
          description: Date of the imaging.
          format: date
        comments:
          type: string
          description: Comments on the imaging result. Literal `|` separators are removed from this partner-facing display text.
          example: No acute findings.
        createdAt:
          format: date-time
          type: string
          description: Date the image was created.
        images:
          description: Document URLs for the imaging results. These can be used to download the images.
          type: array
          items:
            $ref: '#/components/schemas/DocumentUrlDto'
        indexedRecordSpliceType:
          type:
          - string
          - 'null'
          description: Spliced indexed record classification. Null means no splice metadata is available for the imaging result.
          enum:
          - CANVAS_SET
          - SEGMENT_SET
          - PRESPLICED
      required:
      - id
      - title
      - date
      - comments
      - createdAt
      - images
      - indexedRecordSpliceType
    AdditionalRecordDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the additional record.
          format: uuid
        title:
          type: string
          description: Title of the record.
          example: Hospital discharge summary
        date:
          type: string
          description: Date of the record, if provided.
          format: date
        comments:
          type: string
          description: Comments on the record, if any.
          example: Provided by external facility
        createdAt:
          format: date-time
          type: string
          description: Date the record was created.
        images:
          description: Document URLs for the record. These can be used to download the record.
          type: array
          items:
            $ref: '#/components/schemas/DocumentUrlDto'
        indexedRecordSpliceType:
          type:
          - string
          - 'null'
          description: Spliced indexed record classification. Null means no splice metadata is available for the record.
          enum:
          - CANVAS_SET
          - SEGMENT_SET
          - PRESPLICED
      required:
      - id
      - title
      - createdAt
      - images
      - indexedRecordSpliceType
    BodyPartDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the body part.
          format: uuid
        name:
          type: string
          description: Type name for the body part, also the name of the body part. Literal `|` separators are removed from this partner-facing display text.
          example: cervicothoracic
        displayName:
          type: string
          description: Display name for the body part. This is a more user-friendly name. Literal `|` separators are removed from this partner-facing display text.
          example: Cervicothoracic
      required:
      - id
      - name
      - displayName
    MedicationsResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - medications
        items:
          type: array
          items:
            $ref: '#/components/schemas/MedicationItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    FacesheetDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the facesheet.
          format: uuid
        requestId:
          type: string
          description: Facesheet request ID used to retrieve structured output.
          format: uuid
        name:
          type: string
          description: Name of the facesheet.
        date:
          type: string
          description: Date of the facesheet.
          format: date
        title:
          type: string
          description: Title of the facesheet.
          example: Patient Facesheet
        createdAt:
          format: date-time
          type: string
          description: Date and time when the facesheet was created.
        images:
          description: Document URLs for the facesheet. These can be used to download the images.
          type: array
          items:
            $ref: '#/components/schemas/DocumentUrlDto'
      required:
      - id
      - name
      - date
      - title
      - createdAt
      - images
    FamilyHistoryResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - family-history
        items:
          type: array
          items:
            $ref: '#/components/schemas/FamilyHistoryItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    ProblemItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        conditionId:
          type:
          - string
          - 'null'
        encounterId:
          type:
          - string
          - 'null'
        problemCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        name:
          type:
          - string
          - 'null'
        onsetDate:
          type:
          - string
          - 'null'
        categoryCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        clinicalStatus:
          type:
          - string
          - 'null'
        categoryCodeName:
          type:
          - string
          - 'null'
        conditionNote:
          type:
          - string
          - 'null'
        resolutionDate:
          type:
          - string
          - 'null'
        recordedDate:
          type:
          - string
          - 'null'
      required:
      - patientId
      - sources
      - conditionId
      - encounterId
      - problemCodes
      - name
      - onsetDate
      - categoryCodes
      - clinicalStatus
      - categoryCodeName
      - conditionNote
      - resolutionDate
      - recordedDate
    HieDocDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the HIE document.
          format: uuid
        createdAt:
          format: date-time
          type: string
          description: Date of the HIE document.
        title:
          type: string
          description: Title of the HIE document.
        image:
          description: Document URL for the HIE document. That can be used to download the image.
          allOf:
          - $ref: '#/components/schemas/DocumentUrlDto'
        images:
          description: Document URLs for the HIE document.
          type: array
          items:
            $ref: '#/components/schemas/DocumentUrlDto'
      required:
      - id
      - createdAt
      - title
      - image
      - images
    VaccineTypeDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the vaccine type.
          format: uuid
        name:
          type: string
          description: Type name for the vaccine.
          example: adacelTdapVaccine
        displayName:
          type: string
          description: Display name for the vaccine type. This is a more user-friendly name.
          example: Adacel (Tdap) Vaccine
      required:
      - id
      - name
      - displayName
    UpdatePatientInformationRespDto:
      type: object
      properties:
        patientId:
          type: string
          description: ID of the patient whose information was updated.
          format: uuid
        result:
          type: string
          description: Whether the patient information was updated successfully.
          enum:
          - UPDATED
          - NOT_UPDATED
          example: UPDATED
        message:
          type: string
          description: Message describing the result of the update.
          example: Patient information updated successfully
      required:
      - patientId
      - result
      - message
    PatientDocumentsDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        documents:
          description: List of documents for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/DocumentDto'
      required:
      - partnerPatientId
      - documents
    ClinicalDataSourceDto:
      type: object
      properties:
        source:
          type: string
          description: The curated data source for this item.
          enum:
          - HIE
          - provider-facility
          - Surescripts
          example: provider-facility
        retrievalDate:
          type:
          - string
          - 'null'
          description: Date the curated item was uploaded when provided by the upstream service.
          example: '2026-04-01'
        documentId:
          type:
          - string
          - 'null'
          description: Source document identifier when provided for provider/facility records.
          example: b95793ce-321b-45f1-92cb-06743e3ddef9
        documentUrl:
          type:
          - string
          - 'null'
          description: Signed URL to the source document when provided for provider/facility records.
          example: https://documents.example/source.pdf
      required:
      - source
    PathologyResultItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        pathologyResultId:
          type:
          - string
          - 'null'
        pathologyName:
          type:
          - string
          - 'null'
        diagnosis:
          type:
          - string
          - 'null'
        specimenSource:
          type:
          - string
          - 'null'
        date:
          type:
          - string
          - 'null'
        requestInitialProcessedAt:
          type:
          - string
          - 'null'
        requestLastProcessedAt:
          type:
          - string
          - 'null'
      required:
      - patientId
      - sources
      - pathologyResultId
      - pathologyName
      - diagnosis
      - specimenSource
      - date
      - requestInitialProcessedAt
      - requestLastProcessedAt
    PatientLabResultRespDto:
      type: object
      properties:
        resultId:
          type: string
          description: Unique ID of the lab test result.
          example: 9b2f9cf4-291d-4860-bc12-6102305efac5
        resultName:
          type: string
          description: Name of the lab test result. Literal `|` separators are removed from this partner-facing display text.
          example: ALPHA-1-GLOBULIN
        resultValue:
          type: string
          description: Value of the lab test result. Literal `|` separators are removed from this partner-facing display text.
          example: '0.3'
        normalRange:
          type: string
          description: Normal expected range for the lab test result. Literal `|` separators are removed from this partner-facing display text.
          example: 1–3
        memrRetrievedDate:
          type: string
          description: Date when the lab test result was retrieved.
          example: '2025-01-30 20:00:03'
        resultDateOfStudy:
          type: string
          description: Date when the lab test was conducted.
          example: '2024-01-01'
        resultStudyName:
          type: string
          description: Name of the lab test study. Literal `|` separators are removed from this partner-facing display text.
          example: COMPREHENSIVE METABOLIC PANEL
        resultDocumentType:
          type: string
          description: Type of lab test result. Literal `|` separators are removed from this partner-facing display text.
          example: Labcorp
      required:
      - resultId
      - resultName
      - resultValue
      - normalRange
      - memrRetrievedDate
      - resultDateOfStudy
      - resultStudyName
      - resultDocumentType
    FacesheetOutputRowDto:
      type: object
      properties:
        question:
          type: string
        answer:
          type: string
        rationale:
          type: string
        references:
          type: array
          items:
            $ref: '#/components/schemas/FacesheetOutputReferenceDto'
        children:
          type: array
          items:
            $ref: '#/components/schemas/FacesheetOutputChildRowDto'
      required:
      - references
      - children
    AddressInpDto:
      type: object
      properties:
        addressLine1:
          type: string
          description: Street address line 1.
          example: 4990 HOOVER RD
        addressLine2:
          type: string
          description: Street address line 2.
          example: APT 227
        city:
          type: string
          description: Name of the city.
          example: GROVE CITY
        stateCode:
          type: string
          description: Two letter state code for the address.
          example: OH
        postalCode:
          type: string
          description: Postal code for the address - 5 digits.
          example: '43123'
        countryCode:
          type: string
          description: <strong>NOTE:</strong> This field is deprecated and will be removed in a future release.
          default: USA
          deprecated: true
          example: USA
      required:
      - postalCode
    PatientRequestsResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        crrRequests:
          description: List of requests associated with the patient.
          type: array
          items:
            $ref: '#/components/schemas/PatientCrrRequestResponseDto'
        standaloneFacesheetRequests:
          description: List of standalone facesheet requests.
          type: array
          items:
            $ref: '#/components/schemas/PatientCrrRequestResponseDto'
      required:
      - partnerPatientId
      - crrRequests
      - standaloneFacesheetRequests
    CreatePatientV2InpDto:
      type: object
      properties:
        firstName:
          type: string
          description: First name of the patient.
          example: Martha
          minLength: 2
          maxLength: 45
        middleInitial:
          type: string
          description: Middle initial of the patient.
          example: S
        lastName:
          type: string
          description: Last name of the patient.
          example: Rangel
          minLength: 2
          maxLength: 60
        dateOfBirth:
          type: string
          description: Date of birth of the patient, in `YYYY-MM-DD` format.
          example: '1970-03-10'
        phoneCountryCode:
          type: string
          deprecated: true
          description: Country code of the patient's phone number with a `+` at the beginning. Defaults to +1.
          example: '+1'
        phoneNumber:
          type: string
          description: Phone number of the patient, with no special characters (only digits).
          example: '7175501675'
          minLength: 10
          maxLength: 10
        email:
          type: string
          description: Email address of the patient.
          example: martha.rangel@domain.com
        patientAddress:
          description: Physical address of the patient.
          allOf:
          - $ref: '#/components/schemas/AddressInpDto'
        patientGender:
          type: string
          description: Gender of the patient.
          enum:
          - male
          - female
          - na
          - other
        allowDuplicatePatient:
          type: boolean
          description: Override the patient demographics check and create the patient regardless of whether a patient with the same PII exists.
          example: false
      required:
      - firstName
      - lastName
      - dateOfBirth
      - phoneNumber
      - patientAddress
      - patientGender
    MedicationItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        medicationId:
          type:
          - string
          - 'null'
        medicationCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        name:
          type:
          - string
          - 'null'
        practitionerRoleId:
          type:
          - string
          - 'null'
        statementId:
          type:
          - string
          - 'null'
        statementText:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        startDatetime:
          type:
          - string
          - 'null'
        endDatetime:
          type:
          - string
          - 'null'
        doseValue:
          type:
          - string
          - 'null'
        doseUnit:
          type:
          - string
          - 'null'
        doseRoute:
          type:
          - string
          - 'null'
        patientInstructions:
          type:
          - string
          - 'null'
      required:
      - patientId
      - sources
      - medicationId
      - medicationCodes
      - name
      - practitionerRoleId
      - statementId
      - statementText
      - status
      - startDatetime
      - endDatetime
      - doseValue
      - doseUnit
      - doseRoute
      - patientInstructions
    LabTestResultDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the lab test result.
          format: uuid
        labTestId:
          type: string
          description: Unique identifier for the lab test this result belongs to.
          format: uuid
        specialty:
          description: Specialty type of the lab test result.
          allOf:
          - $ref: '#/components/schemas/SpecialtyTypeDto'
        chemistryName:
          type: string
          description: Chemistry name of the lab test result. Literal `|` separators are removed from this partner-facing display text.
          example: CBC
        value:
          type: string
          description: Observed value of the lab test result. Literal `|` separators are removed from this partner-facing display text.
          example: CBC Results
        normalRange:
          type: string
          description: Normal value range of the lab test result. Literal `|` separators are removed from this partner-facing display text.
          example: 10 mg/dL
        isTrendable:
          type: boolean
          description: Whether the lab result is trendable.
        createdAt:
          format: date-time
          type: string
          description: Date and time when the lab test result was created.
      required:
      - id
      - labTestId
      - chemistryName
      - value
      - isTrendable
      - createdAt
    SpecialtyTypeDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the specialty type.
          format: uuid
        name:
          type: string
          description: Name of the specialty type. Literal `|` separators are removed from this partner-facing display text.
          example: hematologyOncology
        displayName:
          type: string
          description: Display name for the specialty type. This is a more user-friendly name. Literal `|` separators are removed from this partner-facing display text.
          example: Hematology/Oncology
      required:
      - id
      - name
      - displayName
    EncountersResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - encounters
        items:
          type: array
          items:
            $ref: '#/components/schemas/EncounterItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    LabTestDocumentDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the lab test.
          format: uuid
        type:
          type: string
          description: Type of the lab test. Literal `|` separators are removed from this partner-facing display text.
          example: Lakeview Labs
        title:
          type: string
          description: Title of the lab test. Literal `|` separators are removed from this partner-facing display text.
          example: Bloodwork Panel
        date:
          type: string
          description: Date of the lab test.
          format: date
        status:
          type: string
          description: Status of the lab test.
          example: PROCESSED
        createdAt:
          format: date-time
          type: string
          description: Date the lab test was created.
        images:
          description: Document URLs for the lab tests. These can be used to download the images.
          type: array
          items:
            $ref: '#/components/schemas/LabTestDocumentUrlDto'
        results:
          description: Results of the lab test.
          type: array
          items:
            $ref: '#/components/schemas/LabTestResultDto'
      required:
      - id
      - type
      - title
      - date
      - status
      - createdAt
      - images
      - results
    PatientAvailableChemRespDto:
      type: object
      properties:
        patientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        availableChemistries:
          description: List of chemistries that are available for the requested patient. Literal `|` separators are removed from these partner-facing display values. Values from this list can be passed to the lab results search endpoint.
          example:
          - ALPHA-1-GLOBULIN
          - ALPHA-2-GLOBULIN
          type: array
          items:
            type: string
      required:
      - patientId
      - availableChemistries
    OtherResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - other
        items:
          type: array
          items:
            $ref: '#/components/schemas/OtherItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    CreatePatientRespDto:
      type: object
      properties:
        patientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
      required:
      - patientId
    EncounterPractitionerDto:
      type: object
      properties:
        referenceId:
          type:
          - string
          - 'null'
        givenName:
          type:
          - string
          - 'null'
        familyName:
          type:
          - string
          - 'null'
        addressStreet:
          type:
          - string
          - 'null'
        addressCity:
          type:
          - string
          - 'null'
        addressState:
          type:
          - string
          - 'null'
        addressUse:
          type:
          - string
          - 'null'
        roleSpecialty:
          type:
          - string
          - 'null'
        role:
          type:
          - string
          - 'null'
        telecoms:
          type: array
          items:
            type: string
      required:
      - referenceId
      - givenName
      - familyName
      - addressStreet
      - addressCity
      - addressState
      - addressUse
      - roleSpecialty
      - role
      - telecoms
    OtherRecordDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the record.
          format: uuid
        type:
          description: Record type information.
          allOf:
          - $ref: '#/components/schemas/OtherRecordTypeDto'
        title:
          type: string
          description: Title of the record.
          example: Lab Results
        date:
          type: string
          description: Date of the record.
          format: date
        status:
          type: string
          description: Status of the record.
          example: PROCESSING
        comments:
          type: string
          description: Comments on the record.
          example: The quick brown fox jumps over the lazy dog.
        createdAt:
          format: date-time
          type: string
          description: Date the record was created.
        images:
          description: Document URLs for the record. These can be used to download the record.
          type: array
          items:
            $ref: '#/components/schemas/DocumentUrlDto'
        indexedRecordSpliceType:
          type:
          - string
          - 'null'
          description: Spliced indexed record classification. Null means no splice metadata is available for the record.
          enum:
          - CANVAS_SET
          - SEGMENT_SET
          - PRESPLICED
      required:
      - id
      - title
      - date
      - status
      - comments
      - createdAt
      - images
      - indexedRecordSpliceType
    PreviousProviderRetrievalRespDto:
      type: object
      properties:
        id:
          type: string
          description: Previous-provider retrieval identifier UUID.
          format: uuid
          example: 11111111-1111-4111-8111-111111111111
      required:
      - id
    PatientProcedureNotesDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        procedureNotes:
          description: List of procedure notes for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/ProcedureNoteDto'
      required:
      - partnerPatientId
      - procedureNotes
    PatientLabResultSearchRespDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        labResults:
          description: List of lab results that were found for the requested patient.
          type: array
          items:
            $ref: '#/components/schemas/PatientLabResultRespDto'
      required:
      - partnerPatientId
      - labResults
    FacesheetRequestRespDto:
      type: object
      properties:
        id:
          type: string
          description: ID.
        status:
          type: string
          description: Status of the request.
          example: FS_PROCESSING
          enum:
          - FS_CLOSED
          - FS_COMPLETE
          - FS_PENDING
          - FS_PROCESSING
        name:
          type: string
          description: Name of the request.
          example: Facesheet-Request
        submittedAt:
          format: date-time
          type: string
          description: Date the request was submitted.
      required:
      - id
      - status
      - name
      - submittedAt
    RequestDatesOfServiceInpDto:
      type: object
      properties:
        serviceStartDate:
          type: string
          description: Date of when the organization started providing care to the patient.
          example: '2026-08-09'
        serviceEndDate:
          type: string
          description: End date of when the organization stopped providing care to the patient.
          example: '2026-09-09'
      required:
      - serviceStartDate
      - serviceEndDate
    FacesheetOutputDto:
      type: object
      properties:
        requestId:
          type: string
        questions:
          type: array
          items:
            $ref: '#/components/schemas/FacesheetOutputRowDto'
      required:
      - requestId
      - questions
    FacesheetOutputSourceDto:
      type: object
      properties:
        source:
          type: string
        retrievalDate:
          type: string
          format: date-time
        curatedDataId:
          type: string
        classificationGroupType:
          type: string
          enum:
          - allergies
          - demographics
          - encounters
          - family-history
          - imaging-notes
          - labs
          - medications
          - other
          - pathology-results
          - problems
          - procedure-notes
          - procedures
          - provider-facility-notes
          - providers
          - social-history
          - vaccinations
          - vitals
          description: Curated patient data endpoint classification for the curatedDataId behind this source. Absent when the source has no supported classification.
        downloadUrl:
          type: string
          description: Signed URL for the source document used by the facesheet output.
    PatientLabResultsSearchBodyInput:
      type: object
      properties:
        searchChemistries:
          deprecated: true
          description: List of lab result names to search for. Literal `|` separators are ignored during matching so values returned from `/patients/{patientId}/lab-results/available` can be used directly.
          example: ALPHA-1-GLOBULIN
          type: array
          items:
            type: string
    PatientFacesheetsDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        facesheets:
          description: List of facesheets for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/FacesheetDto'
      required:
      - partnerPatientId
      - facesheets
    PatientDrugAllergiesDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        drugAllergies:
          description: List of drug allergies for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/DrugAllergyDto'
      required:
      - partnerPatientId
      - drugAllergies
    ProcedureNoteDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the note.
          format: uuid
        title:
          type: string
          description: Title of the note.
          example: Surgery Note
        proceduralist:
          type: string
          description: Name of the surgeon or technician who performed the procedure.
          example: Dr. John Doe
        date:
          type: string
          description: Date of the note.
          format: date
        comments:
          type: string
          description: Comments on the note.
          example: The quick brown fox jumps over the lazy dog.
        createdAt:
          format: date-time
          type: string
          description: Date the note was created.
        images:
          description: Document URLs for the note. These can be used to download the notes.
          type: array
          items:
            $ref: '#/components/schemas/DocumentUrlDto'
        indexedRecordSpliceType:
          type:
          - string
          - 'null'
          description: Spliced indexed record classification. Null means no splice metadata is available for the note.
          enum:
          - CANVAS_SET
          - SEGMENT_SET
          - PRESPLICED
      required:
      - id
      - title
      - proceduralist
      - date
      - comments
      - createdAt
      - images
      - indexedRecordSpliceType
    EncounterDocumentMetadataDto:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
        ctype:
          type:
          - string
          - 'null'
        bucket:
          type:
          - string
          - 'null'
        docId:
          type:
          - string
          - 'null'
        checksum:
          type:
          - string
          - 'null'
        encoding:
          type:
          - string
          - 'null'
        signedUrl:
          type:
          - string
          - 'null'
      required:
      - key
      - ctype
      - bucket
      - docId
      - checksum
      - encoding
      - signedUrl
    DrugAllergyDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the allergy.
          format: uuid
        drugName:
          type: string
          description: Name of the drug.
          example: Isotretinoin
        alternateName:
          type: string
          description: Alternate name of the drug that may be more widely-used.
          example: Accutane
        reaction:
          type: string
          description: Reaction that the drug allergy causes in the patient.
          example: Rash
        comments:
          type: string
          description: Comments on the allergy.
          example: The quick brown fox jumps over the lazy dog.
        createdAt:
          format: date-time
          type: string
          description: Date the allergy was created.
        images:
          description: Document URLs for the allergy. These can be used to download the allergy information.
          type: array
          items:
            $ref: '#/components/schemas/DocumentUrlDto'
        indexedRecordSpliceType:
          type:
          - string
          - 'null'
          description: Spliced indexed record classification. Null means no splice metadata is available for the allergy.
          enum:
          - CANVAS_SET
          - SEGMENT_SET
          - PRESPLICED
      required:
      - id
      - alternateName
      - reaction
      - comments
      - createdAt
      - images
      - indexedRecordSpliceType
    AddressPreviousProviderInpDto:
      type: object
      properties:
        addressLine1:
          type: string
          description: Street address line 1.
          example: 123 Main St
        addressLine2:
          type: string
          description: Street address line 2.
          example: 'Apt # 123'
        city:
          type: string
          description: Name of the city.
          example: Charlotte
        stateCode:
          type: string
          description: Two letter state code for the address.
          example: NC
        postalCode:
          type: string
          description: Postal code for the address - 5 digits.
          example: '28105'
        countryCode:
          type: string
          description: <strong>NOTE:</strong> This field is deprecated and will be removed in a future release.
          default: USA
          deprecated: true
          example: USA
    PatientHieDocsDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        hieDocs:
          description: List of HIE documents for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/HieDocDto'
      required:
      - partnerPatientId
      - hieDocs
    EncounterLocationDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        locationType:
          type:
          - string
          - 'null'
        addressUse:
          type:
          - string
          - 'null'
        address:
          type:
          - string
          - 'null'
        city:
          type:
          - string
          - 'null'
        state:
          type:
          - string
          - 'null'
        postalCode:
          type:
          - string
          - 'null'
      required:
      - name
      - locationType
      - addressUse
      - address
      - city
      - state
      - postalCode
    ProcedureNoteItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        procedureNoteId:
          type:
          - string
          - 'null'
        procedureName:
          type:
          - string
          - 'null'
        dateOfProcedure:
          type:
          - string
          - 'null'
        notes:
          type:
          - string
          - 'null'
        providerFirstName:
          type:
          - string
          - 'null'
        providerLastName:
          type:
          - string
          - 'null'
        providerType:
          type:
          - string
          - 'null'
        professionalDesignation1:
          type:
          - string
          - 'null'
        professionalDesignation2:
          type:
          - string
          - 'null'
        professionalDesignation3:
          type:
          - string
          - 'null'
        requestInitialProcessedAt:
          type:
          - string
          - 'null'
        requestLastProcessedAt:
          type:
          - string
          - 'null'
      required:
      - patientId
      - sources
      - procedureNoteId
      - procedureName
      - dateOfProcedure
      - notes
      - providerFirstName
      - providerLastName
      - providerType
      - professionalDesignation1
      - professionalDesignation2
      - professionalDesignation3
      - requestInitialProcessedAt
      - requestLastProcessedAt
    PatientOtherRecordsDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        otherRecords:
          description: List of other records for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/OtherRecordDto'
      required:
      - partnerPatientId
      - otherRecords
    ProblemsResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - problems
        items:
          type: array
          items:
            $ref: '#/components/schemas/ProblemItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    OtherRecordTypeDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the record type.
          format: uuid
        name:
          type: string
          description: Type name for the record. This is not the name of the record, but the type of record.
          example: labcorp
        displayName:
          type: string
          description: Display name for the record type. This is a more user-friendly name.
          example: Labcorp
      required:
      - id
      - name
      - displayName
    PatientImagingResultsDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        imagingResults:
          description: List of imaging results for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/ImagingResultDto'
      required:
      - partnerPatientId
      - imagingResults
    ProceduresResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - procedures
        items:
          type: array
          items:
            $ref: '#/components/schemas/ProcedureItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    ProviderTypeDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the provider type.
          format: uuid
        name:
          type: string
          description: Type name for the provider. This is not the name of the provider, but the type of provider.
          example: internalMedicine
        displayName:
          type: string
          description: Display name for the provider type. This is a more user-friendly name.
          example: Internal Medicine
      required:
      - id
      - name
      - displayName
    ProviderItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        providerId:
          type:
          - string
          - 'null'
        firstName:
          type:
          - string
          - 'null'
        lastName:
          type:
          - string
          - 'null'
        npi:
          type:
          - string
          - 'null'
        specialty:
          type:
          - string
          - 'null'
        professionalDesignation1:
          type:
          - string
          - 'null'
        professionalDesignation2:
          type:
          - string
          - 'null'
        professionalDesignation3:
          type:
          - string
          - 'null'
        street1:
          type:
          - string
          - 'null'
        street2:
          type:
          - string
          - 'null'
        city:
          type:
          - string
          - 'null'
        state:
          type:
          - string
          - 'null'
        postalCode:
          type:
          - string
          - 'null'
        phoneNumber:
          type:
          - string
          - 'null'
        faxNumber:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
        requestInitialProcessedAt:
          type:
          - string
          - 'null'
        requestLastProcessedAt:
          type:
          - string
          - 'null'
      required:
      - patientId
      - sources
      - providerId
      - firstName
      - lastName
      - npi
      - specialty
      - professionalDesignation1
      - professionalDesignation2
      - professionalDesignation3
      - street1
      - street2
      - city
      - state
      - postalCode
      - phoneNumber
      - faxNumber
      - email
      - requestInitialProcessedAt
      - requestLastProcessedAt
    HieRequestRespDto:
      type: object
      properties:
        id:
          type: string
          description: ID.
        status:
          type: string
          description: Status of the request.
          example: HIE_data_available
          enum:
          - Created
          - HIE_data_available
          - No_HIE_data_available
          - Processing
        submittedAt:
          format: date-time
          type: string
          description: Date the request was submitted.
        alternativeZipCodes:
          description: Alternative zip codes used in the request submission.
          type: array
          items:
            type: string
      required:
      - id
      - status
      - submittedAt
    SocialHistoryItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        socialHistoryId:
          type:
          - string
          - 'null'
        practitionerRoleId:
          type:
          - string
          - 'null'
        socialHistoryText:
          type:
          - string
          - 'null'
        category:
          type:
          - string
          - 'null'
        socialHistoryCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        name:
          type:
          - string
          - 'null'
        observationTimestamp:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        valueCodes:
          type:
          - array
          - 'null'
          items:
            type: string
      required:
      - patientId
      - sources
      - socialHistoryId
      - practitionerRoleId
      - socialHistoryText
      - category
      - socialHistoryCodes
      - name
      - observationTimestamp
      - value
      - valueCodes
    ImagingNotesResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - imaging-notes
        items:
          type: array
          items:
            $ref: '#/components/schemas/ImagingNoteItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    FacesheetOutputChildRowDto:
      type: object
      properties:
        question:
          type: string
        answer:
          type: string
        rationale:
          type: string
        references:
          type: array
          items:
            $ref: '#/components/schemas/FacesheetOutputReferenceDto'
      required:
      - references
    ProcedureNotesResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - procedure-notes
        items:
          type: array
          items:
            $ref: '#/components/schemas/ProcedureNoteItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    ProviderFacilityNoteDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the note.
          format: uuid
        providerType:
          description: Provider type information.
          allOf:
          - $ref: '#/components/schemas/ProviderTypeDto'
        alternateProviderTypeName:
          type: string
          description: Alternate provider type name, used as an override. Literal `|` separators are removed from this partner-facing display text.
          example: nonClinicalProvider
        providerName:
          type: string
          description: Name of the provider. Literal `|` separators are removed from this partner-facing display text.
          example: Lakeview Clinic
        date:
          type: string
          description: Date of the note.
          format: date
        comments:
          type: string
          description: Comments on the note. Literal `|` separators are removed from this partner-facing display text.
          example: Follow up in six months.
        createdAt:
          format: date-time
          type: string
          description: Date the note was created.
        images:
          description: Document URLs for the note. These can be used to download the notes.
          type: array
          items:
            $ref: '#/components/schemas/DocumentUrlDto'
        indexedRecordSpliceType:
          type:
          - string
          - 'null'
          description: Spliced indexed record classification. Null means no splice metadata is available for the note.
          enum:
          - CANVAS_SET
          - SEGMENT_SET
          - PRESPLICED
      required:
      - id
      - providerName
      - date
      - comments
      - createdAt
      - images
      - indexedRecordSpliceType
    EncounterItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        encounterId:
          type:
          - string
          - 'null'
        startTime:
          type:
          - string
          - 'null'
        endTime:
          type:
          - string
          - 'null'
        encounterTypeCodes:
          type: array
          items:
            $ref: '#/components/schemas/EncounterTypeCodeDto'
        typeName:
          type:
          - string
          - 'null'
        hospitalizationDischargeDisposition:
          type:
          - string
          - 'null'
        conditionIdReferences:
          type: array
          items:
            type: string
        locationIdReferences:
          type: array
          items:
            type: string
        practitionerRoleIdReferences:
          type: array
          items:
            type: string
        encounterText:
          type:
          - string
          - 'null'
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/EncounterConditionDto'
        locations:
          type: array
          items:
            $ref: '#/components/schemas/EncounterLocationDto'
        practitioners:
          type: array
          items:
            $ref: '#/components/schemas/EncounterPractitionerDto'
        documentReferences:
          type: array
          items:
            $ref: '#/components/schemas/EncounterDocumentReferenceDto'
      required:
      - patientId
      - sources
      - encounterId
      - startTime
      - endTime
      - encounterTypeCodes
      - typeName
      - hospitalizationDischargeDisposition
      - conditionIdReferences
      - locationIdReferences
      - practitionerRoleIdReferences
      - encounterText
      - conditions
      - locations
      - practitioners
      - documentReferences
    CreateCrrInpDto:
      type: object
      properties:
        releaseToOrgName:
          type: string
          description: Name of the organization making the request.
          example: ABC Hospital
        releaseToProviderName:
          type: string
          description: Name of the provider the patient is being released to.
          example: Dr. Jane Doe
        previousProviders:
          description: List of previous providers known for the requested patient.
          type: array
          items:
            $ref: '#/components/schemas/PreviousProviderInpDto'
        doNotKnowPreviousProvider:
          type: boolean
          deprecated: true
          description: <strong>NOTE:</strong> This field is deprecated and will be removed in a future release. Please use the `previousProviders` field instead.
        reasonForRequest:
          type: integer
          description: 'Reason for the request: `0` for Future Appointment or `2` for Information Gathering.'
          example: 0
          enum:
          - 0
          - 2
        futureAppointmentDate:
          type: string
          description: Date of the future appointment in `YYYY-MM-DD` format. Required if the request reason is `0 (Future Appointment)`.
          example: '2026-09-17'
        requestingProviderEmail:
          type: string
          description: Email address of the provider or physician making the request.
          example: jane.doe@domain.com
        patientAuthFile:
          description: Base-64 encoded file data for the patient authorization file, if available.
          allOf:
          - $ref: '#/components/schemas/EncodedFileInpDto'
        referenceId:
          type: string
          description: User-defined reference number for the request. This can be used for your own records and is not used by the Predoc platform.
          example: '1234567890'
        sendHieRequest:
          type: boolean
          description: Send HIE request.
          example: true
        sendMedicationsRequest:
          type: boolean
          description: Send Medications request.
          example: true
        facesheetConfigId:
          type: string
          description: Facesheet config ID to generate request with.
        facesheetConfigIds:
          description: Facesheet config IDs to generate request with.
          type: array
          items:
            type: string
            format: uuid
      required:
      - releaseToOrgName
      - releaseToProviderName
      - previousProviders
      - reasonForRequest
      - requestingProviderEmail
    AllergiesResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - allergies
        items:
          type: array
          items:
            $ref: '#/components/schemas/AllergyItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    VaccineDocumentUrlDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the vaccine document.
          format: uuid
        url:
          type: string
          description: Signed URL to access the vaccine document.
          format: url
          example: https://example.com/document.pdf
        createdAt:
          format: date-time
          type: string
          description: Date and time when the vaccine document was first created.
      required:
      - id
      - url
    RecordRequestRespDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        requestId:
          type: string
          description: Predoc request identifier for the new patient request.
          format: uuid
        message:
          type: string
          description: Any processing or error messages associated with the request. This field is optional and may be omitted if no message is available.
          example: Patient created successfully
        referenceId:
          type: string
          description: User-defined reference number for the request. This can be used for your own records and is not used by the Predoc platform.
          example: '1234567890'
        previousProviderRetrievals:
          description: Created previous-provider retrievals associated with the request.
          example:
          - id: 11111111-1111-4111-8111-111111111111
          type: array
          items:
            $ref: '#/components/schemas/PreviousProviderRetrievalRespDto'
      required:
      - partnerPatientId
      - requestId
      - message
      - previousProviderRetrievals
    VaccineRecordDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the vaccine record.
          format: uuid
        type:
          description: Vaccine type information.
          allOf:
          - $ref: '#/components/schemas/VaccineTypeDto'
        alternateName:
          type: string
          description: Alternate name for the vaccine, which may be more widely-used.
          example: someOtherVaccine
        date:
          type: string
          description: Date the vaccine was administered.
          format: date
        comments:
          type: string
          description: Comments on the vaccine.
          example: The quick brown fox jumps over the lazy dog.
        createdAt:
          format: date-time
          type: string
          description: Date the vaccine record was created.
        images:
          description: Document URLs for the vaccine record. These can be used to download the record.
          type: array
          items:
            $ref: '#/components/schemas/DocumentUrlDto'
        indexedRecordSpliceType:
          type:
          - string
          - 'null'
          description: Spliced indexed record classification. Null means no splice metadata is available for the vaccine record.
          enum:
          - CANVAS_SET
          - SEGMENT_SET
          - PRESPLICED
      required:
      - id
      - date
      - comments
      - createdAt
      - images
      - indexedRecordSpliceType
    VaccinationItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        immunizationId:
          type:
          - string
          - 'null'
        immunizationCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        name:
          type:
          - string
          - 'null'
        route:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        routeCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        dosageUnit:
          type:
          - string
          - 'null'
        dosageValue:
          type:
          - string
          - 'null'
        occurrenceTime:
          type:
          - string
          - 'null'
        siteCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        site:
          type:
          - string
          - 'null'
      required:
      - patientId
      - sources
      - immunizationId
      - immunizationCodes
      - name
      - route
      - status
      - routeCodes
      - dosageUnit
      - dosageValue
      - occurrenceTime
      - siteCodes
      - site
    DemographicsResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - demographics
        items:
          type: array
          items:
            $ref: '#/components/schemas/DemographicItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    AllergyItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        allergyId:
          type:
          - string
          - 'null'
        practitionerRoleId:
          type:
          - string
          - 'null'
        allergyCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        name:
          type:
          - string
          - 'null'
        recordedDate:
          type:
          - string
          - 'null'
        onsetStartDate:
          type:
          - string
          - 'null'
        onsetEndDate:
          type:
          - string
          - 'null'
        reactionManifestation:
          type:
          - string
          - 'null'
        reactionManifestationCodes:
          type:
          - array
          - 'null'
          items:
            type: string
      required:
      - patientId
      - sources
      - allergyId
      - practitionerRoleId
      - allergyCodes
      - name
      - recordedDate
      - onsetStartDate
      - onsetEndDate
      - reactionManifestation
      - reactionManifestationCodes
    PatientMedicationsDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        medications:
          description: List of medications for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/MedicationDto'
      required:
      - partnerPatientId
      - medications
    PatientVaccineDocumentsDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        vaccineDocuments:
          description: List of vaccine and immunization documents for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/VaccineDocumentDto'
      required:
      - partnerPatientId
      - vaccineDocuments
    MedicationSourceDto:
      type: object
      properties:
        qualifier:
          type: string
        description:
          type: string
      required:
      - qualifier
      - description
    EncodedFileInpDto:
      type: object
      properties:
        encodedFile:
          type: string
          description: Base-64 encoded data of the file being uploaded.
          format: base64
        fileExtension:
          type: string
          description: File extension of the file being uploaded.
          example: pdf
        dataType:
          type: string
          description: Type of the file being uploaded.
          example: image
      required:
      - encodedFile
      - fileExtension
      - dataType
    ImagingNoteItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        imagingNoteId:
          type:
          - string
          - 'null'
        imagingNoteName:
          type:
          - string
          - 'null'
          description: Name of the imaging note. Literal `|` separators are removed from this partner-facing display text.
          example: Chest X-Ray
        imagingType:
          type:
          - string
          - 'null'
          description: Imaging type display text. Literal `|` separators are removed from this partner-facing display text.
          example: X-Ray
        bodyPart:
          type:
          - string
          - 'null'
          description: Imaged body part display text. Literal `|` separators are removed from this partner-facing display text.
          example: Chest
        date:
          type:
          - string
          - 'null'
        notes:
          type:
          - string
          - 'null'
          description: Imaging note text. Literal `|` separators are removed from this partner-facing display text.
          example: No acute findings.
        requestInitialProcessedAt:
          type:
          - string
          - 'null'
        requestLastProcessedAt:
          type:
          - string
          - 'null'
      required:
      - patientId
      - sources
      - imagingNoteId
      - imagingNoteName
      - imagingType
      - bodyPart
      - date
      - notes
      - requestInitialProcessedAt
      - requestLastProcessedAt
    SocialHistoryResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - social-history
        items:
          type: array
          items:
            $ref: '#/components/schemas/SocialHistoryItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    PatientDocumentSearchRespDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        documents:
          description: List of documents that were found for the requested patient.
          type: array
          items:
            $ref: '#/components/schemas/PatientDocumentRespDto'
      required:
      - partnerPatientId
      - documents
    PatientVaccineRecordsDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        vaccineRecords:
          description: List of vaccine and immunization records for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/VaccineRecordDto'
      required:
      - partnerPatientId
      - vaccineRecords
    PatientCrrRequestResponseDto:
      type: object
      properties:
        crrId:
          type: string
          description: ID of the request.
          format: uuid
        createdAt:
          format: date-time
          type: string
          description: Date the request was created.
        creatorFirstName:
          type: string
          description: First name of the user making the request.
          example: John
        creatorLastName:
          type: string
          description: Last name of the user making the request.
          example: Doe
        updatedAt:
          format: date-time
          type: string
        requestingProviderName:
          type: string
          description: Name of the provider or physician making the request.
          example: Dr. Jane Doe
        requestReason:
          type: string
          description: Reason for the request.
          example: Information Gathering
        referenceId:
          type: string
          description: User-defined reference number for the request. This can be used for your own records and is not used by the Predoc platform.
          example: '1234567890'
        cumulativeRequestStatus:
          type: object
          properties:
            OPEN:
              example: 1
              type: number
            IN_PROGRESS:
              example: 2
              type: number
            COMPLETED:
              example: 3
              type: number
        requestedProviders:
          description: List of previous providers included in the original request.
          type: array
          items:
            $ref: '#/components/schemas/PreviousProviderResponseDto'
        hieRequests:
          description: HIE requests (if exists) included in the original request.
          type: array
          items:
            $ref: '#/components/schemas/HieRequestRespDto'
        medicationsRequests:
          description: Medications requests (if exists) included in the original request.
          type: array
          items:
            $ref: '#/components/schemas/HieRequestRespDto'
        appointmentDate:
          format: date-time
          type: string
          description: Date of the upcoming appointment, if set.
        facesheetRequests:
          description: Facesheet requests (if exists) included in the original request.
          type: array
          items:
            $ref: '#/components/schemas/FacesheetRequestRespDto'
      required:
      - crrId
      - createdAt
      - creatorFirstName
      - creatorLastName
      - updatedAt
      - requestReason
      - cumulativeRequestStatus
      - requestedProviders
      - appointmentDate
    UpdatePatientInformationInpDto:
      type: object
      properties:
        firstName:
          type: string
          description: First name of the patient.
          example: Martha
          minLength: 2
          maxLength: 45
        middleName:
          type: string
          description: Middle name of the patient.
          example: Sara
        middleInitial:
          type: string
          description: Middle initial of the patient.
          example: S
        lastName:
          type: string
          description: Last name of the patient.
          example: Rangel
          minLength: 2
          maxLength: 60
        dateOfBirth:
          type: string
          description: Date of birth of the patient, in `YYYY-MM-DD` format.
          example: '1970-03-10'
        patientGender:
          type: string
          description: Gender of the patient.
          enum:
          - male
          - female
          - na
          - other
        phoneCountryCode:
          type: string
          deprecated: true
          description: Country code of the patient’s phone number with a `+` at the beginning. Defaults to +1.
          example: '+1'
        phoneNumber:
          type: string
          description: Phone number of the patient, with no special characters (only digits).
          example: '7175501675'
          minLength: 10
          maxLength: 10
        email:
          type: string
          description: Email address of the patient.
          example: martha.rangel@domain.com
        patientAddress:
          description: Physical address of the patient.
          allOf:
          - $ref: '#/components/schemas/AddressInpDto'
        primaryLanguage:
          type: string
          description: Accepted for backward compatibility. This value is not currently applied to patient updates.
          example: english
      required:
      - firstName
      - lastName
      - dateOfBirth
      - patientGender
      - phoneNumber
      - patientAddress
    OtherItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        otherId:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        date:
          type:
          - string
          - 'null'
        requestInitialProcessedAt:
          type:
          - string
          - 'null'
        requestLastProcessedAt:
          type:
          - string
          - 'null'
      required:
      - patientId
      - sources
      - otherId
      - title
      - date
      - requestInitialProcessedAt
      - requestLastProcessedAt
    MedicationDto:
      type: object
      properties:
        medicationId:
          type: string
        medicationTitle:
          type: string
        dosageValue:
          type: string
        dosageFormRaw:
          type: string
        dosageForm:
          type: string
        dosageUnitRaw:
          type: string
        dosageUnit:
          type: string
        diagnosis:
          type: string
        prescriberFirstName:
          type: string
        prescriberLastName:
          type: string
        prescriberPracticeName:
          type: string
        prescriberNpi:
          type: string
        status:
          type: string
        writtenDate:
          format: date-time
          type: string
        lastFillDate:
          format: date-time
          type: string
        quantityValue:
          type: string
        quantityUnitRaw:
          type: string
        quantityUnit:
          type: string
        daysSupply:
          type: number
        refillsRemaining:
          type: number
        substitutions:
          type: number
        prescriberOrderNumber:
          type: string
        priorAuthNumber:
          type: string
        diagnosisQualifier:
          type: string
        sources:
          type: array
          items:
            $ref: '#/components/schemas/MedicationSourceDto'
        createdAt:
          format: date-time
          type: string
      required:
      - medicationId
      - medicationTitle
      - prescriberFirstName
      - prescriberLastName
      - prescriberPracticeName
      - prescriberNpi
      - lastFillDate
      - sources
      - createdAt
    EncounterDocumentReferenceDto:
      type: object
      properties:
        referenceType:
          type:
          - string
          - 'null'
        contentType:
          type:
          - string
          - 'null'
        documentMetadata:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/EncounterDocumentMetadataDto'
      required:
      - referenceType
      - contentType
      - documentMetadata
    PatientProviderFacilityNotesDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        providerFacilityNotes:
          description: List of provider/facility notes for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/ProviderFacilityNoteDto'
      required:
      - partnerPatientId
      - providerFacilityNotes
    PatientLabTestResultsDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner patient ID for use when making patient requests.
          format: uuid
        labTests:
          description: List of lab test results for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/LabTestDocumentDto'
      required:
      - partnerPatientId
      - labTests
    ProcedureItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        procedureId:
          type:
          - string
          - 'null'
        encounterId:
          type:
          - string
          - 'null'
        procedureCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        name:
          type:
          - string
          - 'null'
        procedureNote:
          type:
          - string
          - 'null'
        procedureDatetime:
          type:
          - string
          - 'null'
        asserterPractitionerRoleId:
          type:
          - string
          - 'null'
        performerPractitionerRoleId:
          type:
          - string
          - 'null'
        reason:
          type:
          - string
          - 'null'
        reasonCodes:
          type:
          - array
          - 'null'
          items:
            type: string
      required:
      - patientId
      - sources
      - procedureId
      - encounterId
      - procedureCodes
      - name
      - procedureNote
      - procedureDatetime
      - asserterPractitionerRoleId
      - performerPractitionerRoleId
      - reason
      - reasonCodes
    EncounterConditionDto:
      type: object
      properties:
        conditionName:
          type:
          - string
          - 'null'
        conditionOnsetDate:
          type:
          - string
          - 'null'
        conditionRecordedDate:
          type:
          - string
          - 'null'
        conditionClinicalStatus:
          type:
          - string
          - 'null'
        conditionCategoryCodeName:
          type:
          - string
          - 'null'
        conditionText:
          type:
          - string
          - 'null'
      required:
      - conditionName
      - conditionOnsetDate
      - conditionRecordedDate
      - conditionClinicalStatus
      - conditionCategoryCodeName
      - conditionText
    VitalItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        vitalSignId:
          type:
          - string
          - 'null'
        observationCategory:
          type:
          - string
          - 'null'
        vitalSignCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        observationName:
          type:
          - string
          - 'null'
        observationText:
          type:
          - string
          - 'null'
        observationDatetime:
          type:
          - string
          - 'null'
        observationUnit:
          type:
          - string
          - 'null'
        observationValue:
          type:
          - string
          - 'null'
        groupingObservationId:
          type:
          - string
          - 'null'
      required:
      - patientId
      - sources
      - vitalSignId
      - observationCategory
      - vitalSignCodes
      - observationName
      - observationText
      - observationDatetime
      - observationUnit
      - observationValue
      - groupingObservationId
    ProviderFacilityNoteItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        providerFacilityNoteId:
          type:
          - string
          - 'null'
        facilityName:
          type:
          - string
          - 'null'
          description: Facility name. Literal `|` separators are removed from this partner-facing display text.
          example: Verona Clinic
        noteTitle:
          type:
          - string
          - 'null'
          description: Provider/facility note title. Literal `|` separators are removed from this partner-facing display text.
          example: Consult Note
        notes:
          type:
          - string
          - 'null'
          description: Provider/facility note text. Literal `|` separators are removed from this partner-facing display text.
          example: Follow up in six months.
        providerFirstName:
          type:
          - string
          - 'null'
          description: Provider first name. Literal `|` separators are removed from this partner-facing display text.
          example: Jane
        providerLastName:
          type:
          - string
          - 'null'
          description: Provider last name. Literal `|` separators are removed from this partner-facing display text.
          example: Smith
        providerFacilityType:
          type:
          - string
          - 'null'
          description: Provider/facility type display text. Literal `|` separators are removed from this partner-facing display text.
          example: clinic
        professionalDesignation1:
          type:
          - string
          - 'null'
          description: Professional designation. Literal `|` separators are removed from this partner-facing display text.
          example: MD
        professionalDesignation2:
          type:
          - string
          - 'null'
          description: Professional designation. Literal `|` separators are removed from this partner-facing display text.
          example: null
        professionalDesignation3:
          type:
          - string
          - 'null'
          description: Professional designation. Literal `|` separators are removed from this partner-facing display text.
          example: null
        serviceStartDate:
          type:
          - string
          - 'null'
        serviceEndDate:
          type:
          - string
          - 'null'
        requestInitialProcessedAt:
          type:
          - string
          - 'null'
        requestLastProcessedAt:
          type:
          - string
          - 'null'
      required:
      - patientId
      - sources
      - providerFacilityNoteId
      - facilityName
      - noteTitle
      - notes
      - providerFirstName
      - providerLastName
      - providerFacilityType
      - professionalDesignation1
      - professionalDesignation2
      - professionalDesignation3
      - serviceStartDate
      - serviceEndDate
      - requestInitialProcessedAt
      - requestLastProcessedAt
    RequestClinicalSummaryInpDto:
      type: object
      properties:
        categories:
          type: array
          description: List of clinical summary categories to include in the summary document.
          items:
            type: string
            enum:
            - additional_records
            - imaging
            - medications
            - procedure_notes
            - provider_facility_notes
            - results_bloodwork
        fromDate:
          type: string
          description: Starting (inclusive) date for the clinical summary, in `YYYY-MM-DD` format. If not provided, the earliest date available is used.
          example: '2020-12-01'
        toDate:
          type: string
          description: Ending (exclusive) date for the clinical summary, in `YYYY-MM-DD` format. The date must be after the `fromDate`. If not provided, the current date is used.
          example: '2020-12-31'
      required:
      - categories
    LabItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        labId:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        labCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        value:
          type:
          - string
          - 'null'
        unit:
          type:
          - string
          - 'null'
        observationCategory:
          type:
          - string
          - 'null'
        diagnosticReportName:
          type:
          - string
          - 'null'
        recordedDatetime:
          type:
          - string
          - 'null'
        interpretation:
          type:
          - string
          - 'null'
        labText:
          type:
          - string
          - 'null'
        performerPractitionerRoleIdReferences:
          type: array
          items:
            type: string
        interpreterPractitionerRoleIdReferences:
          type: array
          items:
            type: string
      required:
      - patientId
      - sources
      - labId
      - name
      - labCodes
      - value
      - unit
      - observationCategory
      - diagnosticReportName
      - recordedDatetime
      - interpretation
      - labText
      - performerPractitionerRoleIdReferences
      - interpreterPractitionerRoleIdReferences
    ProvidersResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - providers
        items:
          type: array
          items:
            $ref: '#/components/schemas/ProviderItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    FamilyHistoryItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        familyMemberHistoryId:
          type:
          - string
          - 'null'
        sexCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        sexDisplay:
          type:
          - string
          - 'null'
        conditionCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        conditionDisplay:
          type:
          - string
          - 'null'
        relationshipCodes:
          type:
          - array
          - 'null'
          items:
            type: string
        relationshipDisplay:
          type:
          - string
          - 'null'
        notes:
          type:
          - string
          - 'null'
      required:
      - patientId
      - sources
      - familyMemberHistoryId
      - sexCodes
      - sexDisplay
      - conditionCodes
      - conditionDisplay
      - relationshipCodes
      - relationshipDisplay
      - notes
    PatientDocumentSearchInpDto:
      type: object
      properties:
        categories:
          type: array
          description: List of document types to search for. If not provided, all document types are returned.
          items:
            type: string
            enum:
            - provider_facility_notes
            - results_bloodwork
            - imaging
            - procedure_notes
            - vaccines_immunizations
            - drug_allergies
            - documents/facesheets
            - other_records
            - hie_data
            - facesheets
            - medications
        fromDate:
          type: string
          description: Starting (inclusive) date for the available document, in `YYYY-MM-DD` format. If not provided, the earliest date available is used.
          example: '2020-12-01'
        toDate:
          type: string
          description: Ending (exclusive) date for the available document, in `YYYY-MM-DD` format. The date must be after the `fromDate`. If not provided, the current date is used.
          example: '2020-12-31'
    DemographicItemDto:
      type: object
      properties:
        patientId:
          type:
          - string
          - 'null'
          description: Partner-facing patient identifier.
          example: 11111111-1111-4111-8111-111111111111
        sources:
          description: Curated source provenance for the item.
          type: array
          items:
            $ref: '#/components/schemas/ClinicalDataSourceDto'
        givenName:
          type:
          - string
          - 'null'
        familyName:
          type:
          - string
          - 'null'
        dateOfBirth:
          type:
          - string
          - 'null'
        middleName:
          type:
          - string
          - 'null'
        gender:
          type:
          - string
          - 'null'
        maritalStatus:
          type:
          - string
          - 'null'
        race:
          type:
          - array
          - 'null'
          items:
            type: string
        language:
          type:
          - string
          - 'null'
        telephones:
          type:
          - array
          - 'null'
          items:
            type: string
        emails:
          type:
          - array
          - 'null'
          items:
            type: string
        addressLine1:
          type:
          - string
          - 'null'
        addressLine2:
          type:
          - string
          - 'null'
        city:
          type:
          - string
          - 'null'
        state:
          type:
          - string
          - 'null'
        county:
          type:
          - string
          - 'null'
        postalCode:
          type:
          - string
          - 'null'
        patientCountry:
          type:
          - string
          - 'null'
        socialNumber:
          type:
          - string
          - 'null'
      required:
      - patientId
      - sources
      - givenName
      - familyName
      - dateOfBirth
      - middleName
      - gender
      - maritalStatus
      - race
      - language
      - telephones
      - emails
      - addressLine1
      - addressLine2
      - city
      - state
      - county
      - postalCode
      - patientCountry
      - socialNumber
    PreviousProviderResponseDto:
      type: object
      properties:
        id:
          type: integer
          description: Legacy previous-provider ID.
          example: 12345
        retrievalId:
          type: string
          description: UUID retrieval identifier to use with previous-provider retrieval status and close endpoints.
          format: uuid
        currentOrganizationName:
          type: string
          description: Name of the current organization.
          example: Lakeview Medical Center
        providerName:
          type: string
          description: Name of the provider.
          example: Jane Doe
        practiceName:
          type: string
          description: Name of the practice.
          example: Lakeview Medical Center
        officeStreetAddress1:
          type: string
          description: Street address of the office.
          example: 1234 Main St
        officeStreetAddress2:
          type: string
          description: Secondary street address of the office.
          example: Apt 1
        officeCity:
          type: string
          description: City of the office address.
          example: Lakeview
        officeState:
          type: string
          description: State of the office address.
          example: CA
        officeZip:
          type: string
          description: ZIP code of the office address.
          example: '94901'
        officePhoneNumber:
          type: string
          description: Phone number of the office.
          example: '1234567890'
        serviceStartDate:
          format: date-time
          type: string
        serviceEndDate:
          format: date-time
          type: string
        medicalRecordType:
          type: string
          description: Type of medical record.
          example: imaging
        status:
          type: string
          description: Status of the request.
          example: OPEN
        completeMedicalRecord:
          type: boolean
          description: Whether a complete medical record was requested.
          example: true
      required:
      - id
      - currentOrganizationName
      - providerName
      - practiceName
      - officeStreetAddress1
      - officeStreetAddress2
      - officeCity
      - officeState
      - officeZip
      - officePhoneNumber
      - serviceStartDate
      - serviceEndDate
      - medicalRecordType
      - status
      - completeMedicalRecord
    DocumentUrlDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the document.
          format: uuid
        url:
          type: string
          description: Signed URL to access the document.
          format: url
          example: https://example.com/document.pdf
        createdAt:
          format: date-time
          type: string
          description: Date and time when the document was first created.
      required:
      - id
      - url
    LabsResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - labs
        items:
          type: array
          items:
            $ref: '#/components/schemas/LabItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    PatientSearchBodyInput:
      type: object
      properties:
        firstName:
          type: string
          deprecated: true
          description: First name of the patient.
          example: Martha
          maxLength: 45
        lastName:
          type: string
          deprecated: true
          description: Last name of the patient.
          example: Rangel
          maxLength: 60
        phoneNumber:
          type: string
          deprecated: true
          description: Phone number of the patient, digits only.
          example: '7175501675'
          minLength: 10
          maxLength: 10
        dateOfBirth:
          format: date-time
          type: string
          deprecated: true
          description: Date of birth of the patient, in `YYYY-MM-DD` format.
          example: '1970-03-10'
    FacesheetOutputReferenceDto:
      type: object
      properties:
        sources:
          type: array
          items:
            $ref: '#/components/schemas/FacesheetOutputSourceDto'
      required:
      - sources
    VaccinationsResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - vaccinations
        items:
          type: array
          items:
            $ref: '#/components/schemas/VaccinationItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    PatientDocumentRespDto:
      type: object
      properties:
        drugAllergies:
          description: List of drug allergies for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/DrugAllergyDto'
        documents:
          description: List of documents for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/DocumentDto'
        imagingResults:
          description: List of imaging results for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/ImagingResultDto'
        labTests:
          description: List of lab test results for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/LabTestDocumentDto'
        otherRecords:
          description: List of other records for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/OtherRecordDto'
        procedureNotes:
          description: List of procedure notes for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/ProcedureNoteDto'
        providerFacilityNotes:
          description: List of provider/facility notes for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/ProviderFacilityNoteDto'
        vaccineRecords:
          description: List of vaccine and immunization records for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/VaccineRecordDto'
        vaccineDocuments:
          description: List of vaccine and immunization documents for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/VaccineDocumentDto'
        facesheets:
          description: List of facesheets for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/FacesheetDto'
        hieDocs:
          description: List of HIE documents for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/HieDocDto'
        medications:
          description: List of Medications for the requested patient, if any.
          type: array
          items:
            $ref: '#/components/schemas/MedicationDto'
      required:
      - drugAllergies
      - documents
      - imagingResults
      - labTests
      - otherRecords
      - procedureNotes
      - providerFacilityNotes
      - vaccineRecords
      - vaccineDocuments
      - facesheets
      - hieDocs
      - medications
    PathologyResultsResponseDto:
      type: object
      properties:
        partnerPatientId:
          type: string
          description: Partner-facing patient identifier from the request path.
          example: 11111111-1111-4111-8111-111111111111
        patientKey:
          type: string
          description: Patient key stored in core-api.
          example: patient-key-123
        classificationGroupType:
          type: string
          enum:
          - pathology-results
        items:
          type: array
          items:
            $ref: '#/components/schemas/PathologyResultItemDto'
      required:
      - partnerPatientId
      - patientKey
      - classificationGroupType
      - items
    PatientSummaryResDto:
      type: object
      properties:
        patientSummaryRequestId:
          type: string
          description: Identifier that is used in subsequent API requests to check the status and retrieve the patient summary.
          format: uuid
        patientSummaryRequestStatus:
          type: string
          description: Status of the patient summary request.
          enum:
          - QUEUEING
          - QUEUED
          - GENERATING
          - ERROR
          - READY
          example: QUEUED
        patientSummaryRequestStatusMessage:
          type: string
          description: Any messages about the status of the patient summary request. This can include any errors that may have occurred during the request or notifications that the patient doesn't contain any of the requested categories.
          example: Patient summary request submitted successfully
        documentLink:
          type: string
          description: Once the document is in the `READY` status, this is the signed URL to download the document. This URL will expire after 24 hours.
          format: url
          example: https://example.com/patient-summary.pdf
      required:
      - patientSummaryRequestStatus
      - patientSummaryRequestStatusMessage
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
x-provenance:
  method: searched
  source: https://docs.predoc.ai/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.predoc.ai/reference/authcontroller_signin_v1.md
  - https://docs.predoc.ai/reference/curatedpatientdatacontroller_getcuratedpatientdata_v1.md
  - https://docs.predoc.ai/reference/documentcontroller_getpatientclinicalsummary_v1.md
  - https://docs.predoc.ai/reference/patientcontroller_addrequesttoexistingpatient_v1.md
  - https://docs.predoc.ai/reference/patientcontroller_createpatient_v2.md
  - https://docs.predoc.ai/reference/patientcontroller_getavailablepatientchemistries_v1.md
  - https://docs.predoc.ai/reference/patientcontroller_getpatientinformation_v1.md
  - https://docs.predoc.ai/reference/patientcontroller_getpatientlabresultsbysearch_v1.md
  - https://docs.predoc.ai/reference/patientcontroller_getpatientrequests_v1.md
  - https://docs.predoc.ai/reference/patientcontroller_requestpatientclinicalsummary_v1.md
  - https://docs.predoc.ai/reference/patientcontroller_searchpatientdocuments_v2.md
  - https://docs.predoc.ai/reference/patientcontroller_searchpatientsbyinformation_v1.md
  - https://docs.predoc.ai/reference/patientcontroller_updatepatientinformation_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientadditionalrecords_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientdocuments_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientdrugallergies_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientfacesheetoutput_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientfacesheets_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatienthiedocs_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientimagingresults_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientlabtests_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientmedications_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientotherrecords_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientprocedurenotes_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientproviderfacilitynotes_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientvaccinedocuments_v1.md
  - https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientvaccinerecords_v1.md
  - https://docs.predoc.ai/reference/recorduploadcontroller_getanonymousrecorduploadstatus_v1.md
  - https://docs.predoc.ai/reference/recorduploadcontroller_uploadanonymousrecord_v1.md
  - https://docs.predoc.ai/reference/recorduploadcontroller_uploadrecordv2_v2.md
  - https://docs.predoc.ai/reference/requestcontroller_createrecordrequestv2_v2.md
  - https://docs.predoc.ai/reference/requestcontroller_facesheetconfigs_v1.md
  - https://docs.predoc.ai/reference/requestcontroller_getlistofrecordrequests_v2.md
  - https://docs.predoc.ai/reference/requestcontroller_updateexistingrecordrequest_v1.md
  - https://docs.predoc.ai/reference/retrievalcontroller_closeretrieval_v1.md
  - https://docs.predoc.ai/reference/retrievalcontroller_getretrieval_v1.md
  - https://docs.predoc.ai/reference/webhookconfigurationcontroller_createwebhookconfiguration_v1.md
  - https://docs.predoc.ai/reference/webhookconfigurationcontroller_deletewebhookconfiguration_v1.md
  - https://docs.predoc.ai/reference/webhookconfigurationcontroller_listwebhookconfigurations_v1.md
  - https://docs.predoc.ai/reference/webhookconfigurationcontroller_updatewebhookconfiguration_v1.md
  merge:
    pages: 40
    deduped: 88
    conflicts_kept_first: 0