> ## Documentation Index
> Fetch the complete documentation index at: https://dev.nimbo-x.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List a patient's separate vital-sign captures

> Lists individual saved vital-sign captures for the authorized patient when the organization has enabled clinical sharing. Supply encounter_id to limit the history to one encounter. Results are paginated by capture and ordered newest first, with undated captures last.



## OpenAPI

````yaml /openapi/nimbo_patient_portal.yml get /api/v1/patient_portal/people/{person_id}/vital_signs_history
openapi: 3.1.0
info:
  title: Nimbo patient portal
  version: 1.0.0
  description: >-
    Nimbo API reference. Use the API host and integration access provided by
    Nimbo.
servers:
  - url: https://api.example.test
security: []
tags:
  - name: Patient Portal
  - name: Patient portal authentication
paths:
  /api/v1/patient_portal/people/{person_id}/vital_signs_history:
    get:
      tags:
        - Patient Portal
      summary: List a patient's separate vital-sign captures
      description: >-
        Lists individual saved vital-sign captures for the authorized patient
        when the organization has enabled clinical sharing. Supply encounter_id
        to limit the history to one encounter. Results are paginated by capture
        and ordered newest first, with undated captures last.
      operationId: listPatientPortalPersonVitalSignsHistory
      parameters:
        - name: person_id
          in: path
          required: true
          schema:
            type: integer
          example: 123
        - name: encounter_id
          in: query
          description: >-
            Optional parent encounter ID, distinct from consultation ID. Must
            identify a non-deleted encounter belonging to the selected patient;
            invalid values return 404. Omit to include standalone captures and
            captures from all visits.
          schema:
            type: integer
            minimum: 1
        - name: page
          in: query
          description: >-
            Nonpositive or nonnumeric input defaults to 1; values above the
            maximum are clamped.
          schema:
            type: integer
            minimum: 1
            maximum: 2147483647
            default: 1
          example: 1
        - name: per_page
          in: query
          description: >-
            Nonpositive or nonnumeric input defaults to 20; values above 50 are
            clamped to 50.
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 20
          example: 20
      responses:
        '200':
          description: >-
            Separate saved captures. Empty history and out-of-range pages return
            an empty array; total_pages is zero only when no eligible captures
            match. Field labels and units come from saved content, without
            consulting today's field configuration.
          content:
            application/json:
              schema:
                type: object
                required:
                  - vital_signs_history
                  - meta
                additionalProperties: false
                properties:
                  vital_signs_history:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - consultation_id
                        - encounter_id
                        - encounter
                        - recorded_at
                        - updated_at
                        - set_type
                        - clinician
                        - measurements
                      additionalProperties: false
                      properties:
                        id:
                          type: integer
                          description: >-
                            Stable saved-capture identity; multiple captures can
                            belong to the same encounter.
                        consultation_id:
                          type:
                            - integer
                            - 'null'
                          description: >-
                            Linked kept consultation owned by the selected
                            patient; null when absent or inaccessible.
                        encounter_id:
                          type:
                            - integer
                            - 'null'
                          description: >-
                            Parent encounter ID, distinct from consultation_id;
                            null when absent, deleted or inaccessible.
                        encounter:
                          oneOf:
                            - type: object
                              required:
                                - id
                                - starts_at
                                - cause
                              additionalProperties: false
                              properties:
                                id:
                                  type: integer
                                starts_at:
                                  type:
                                    - string
                                    - 'null'
                                  format: date-time
                                cause:
                                  type:
                                    - string
                                    - 'null'
                                  description: >-
                                    Encounter heading; private consultation
                                    causes are masked with the existing portal
                                    placeholder.
                            - type: 'null'
                        recorded_at:
                          allOf:
                            - type:
                                - string
                                - 'null'
                              format: date-time
                          description: >-
                            Stored capture created_at, possibly supplied during
                            creation; not an independently recorded measurement
                            time.
                        updated_at:
                          allOf:
                            - type:
                                - string
                                - 'null'
                              format: date-time
                          description: >-
                            Latest saved modification; previous overwritten
                            values are not reconstructed.
                        set_type:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Original capture grouping, without restricting
                            history to a fixed vital-sign list.
                        clinician:
                          oneOf:
                            - type: object
                              required:
                                - id
                                - name
                              additionalProperties: false
                              description: >-
                                Account attributed to the capture; not proof of
                                who performed or entered the measurement.
                              properties:
                                id:
                                  type: integer
                                name:
                                  type:
                                    - string
                                    - 'null'
                            - type: 'null'
                        measurements:
                          type: array
                          minItems: 1
                          description: >-
                            Populated scalar measurements in this capture, with
                            no carry-forward from other captures. Includes
                            custom fields regardless of current activation.
                            Nulls, whitespace-only strings, objects, arrays and
                            unfilled definitions are omitted; zero and false are
                            preserved. Current canonical elements override the
                            newest same-organization custom-form snapshot for
                            each key, including explicit clears. A snapshot
                            supplies missing keys only when its updated_at is at
                            least the capture's updated_at and both timestamps
                            are known, so older snapshots cannot restore values
                            omitted on edits. Whitespace means the explicit
                            Unicode White_Space code-point set, independent of
                            database locale. Measurement order is not
                            significant.
                          items:
                            type: object
                            required:
                              - key
                              - value
                              - units
                              - label
                              - custom
                            additionalProperties: false
                            properties:
                              key:
                                type: string
                                description: >-
                                  Original field key; do not identify
                                  measurements by label alone.
                              value:
                                type:
                                  - string
                                  - number
                                  - boolean
                                description: >-
                                  Original stored scalar value, without coercion
                                  or unit conversion.
                              units:
                                type:
                                  - string
                                  - 'null'
                                description: >-
                                  First populated saved string from units or
                                  unit; null when neither is valid, with no
                                  current-catalog substitution.
                              label:
                                type:
                                  - string
                                  - 'null'
                                description: >-
                                  Saved label when available; clients can
                                  localize standard keys or show the original
                                  key as a fallback.
                              custom:
                                type: boolean
                                description: >-
                                  Saved custom flag, or true for a measurement
                                  supplied only by the custom-form response.
                  meta:
                    type: object
                    required:
                      - page
                      - per_page
                      - total_pages
                    additionalProperties: false
                    properties:
                      page:
                        type: integer
                        minimum: 1
                      per_page:
                        type: integer
                        minimum: 1
                        maximum: 50
                      total_pages:
                        type: integer
                        minimum: 0
              example:
                vital_signs_history: []
                meta:
                  page: 1
                  per_page: 20
                  total_pages: 0
        '401':
          description: Missing, expired, invalid, or unauthorized patient portal token.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                additionalProperties: false
                properties:
                  error:
                    type: string
              examples:
                unauthorized:
                  value:
                    error: Unauthorized
        '403':
          description: >-
            The patient's organization has not explicitly enabled clinical-data
            sharing.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                additionalProperties: false
                properties:
                  error:
                    type: string
              examples:
                not_shared:
                  value:
                    error: Clinical data is not shared
        '404':
          description: >-
            The requested resource was not found or is outside the authorized
            patient scope.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                additionalProperties: false
                properties:
                  error:
                    type: string
              examples:
                not_found:
                  value:
                    error: Not found
      security:
        - PatientPortalToken: []
components:
  securitySchemes:
    PatientPortalToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Patient portal JWT accepted either as a raw Authorization header value
        or as a Bearer token for client compatibility.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.