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

# Change a medical record

> Changes a record: a test's result, a diagnosis's notes, a new date. Its task moves with it, and is marked done when the record is. To mark a scheduled record done and make the next of a series, complete it instead. Needs **write** on Animals.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/animals/animals/{id}/medical/{recordId}
openapi: 3.1.0
info:
  title: RescueConsole API
  version: '2026-09-19'
  description: >-
    Your own organization's records, from your own software. There is no
    sandbox: every request goes to your live organization.
servers:
  - url: https://{organization}.rescueconsole.com
    description: Your own organization's address, the one you sign in at.
    variables:
      organization:
        default: your-rescue
        description: >-
          The first part of the address you sign in at. A key only works at the
          address of the organization it was made in.
security:
  - apiKey: []
tags:
  - name: Animals
    description: The animals in your care, and the ones you have placed.
  - name: Animal notes
    description: Notes written on an animal's record.
  - name: Animal weights
    description: An animal's weight readings, one per weighing.
  - name: Animal medical records
    description: >-
      Vaccines, treatments, procedures, tests, exams and other medical records
      on one animal.
  - name: Animal placements
    description: The people an animal came from or has been placed with, over time.
  - name: Animal nutrition
    description: 'What an animal eats: its feeding list and its diet.'
  - name: Animal relationships
    description: Siblings, parents, offspring and bonded pairs.
  - name: Animal tags
    description: Your own short labels on an animal.
  - name: Breeds
    description: The breed or kind lists your intake form offers for each species.
  - name: Litters
    description: Litters, and the animals born into them.
  - name: Locations and housing
    description: >-
      The places animals are housed at each of your locations: campuses,
      buildings, rooms and cages, the tunnels that join cages into one space,
      and who is in each.
  - name: Foster homes
    description: >-
      The people who foster for you, what each home can take, and the animals
      offered to and placed with them.
  - name: Intakes
    description: >-
      How each animal arrived: the route in, who brought it, why it was given up
      and the state it came in.
  - name: Medical due
    description: >-
      Medical work that is outstanding across all your animals, and one medical
      record added to many animals at once.
  - name: Transports
    description: >-
      Transport runs: a chain of drives, each leg with its own driver, that
      moves animals from one place to another.
  - name: Animal calendar
    description: >-
      The dated things in animal care on one calendar: medical work due,
      adoptions, foster placements starting and ending, arrivals, and meet and
      greets.
  - name: Animal reports
    description: >-
      The operations report: intakes, outcomes, live release rate and the
      animals in your care, each figure with its own definition.
  - name: Adoption applications
    description: >-
      Applications to adopt or foster, from first draft to a decision, and the
      adoption contract signed on an approved one.
  - name: Adoptions
    description: >-
      Animals that went home, what each adopter owes and has paid, and closing
      or reversing the adoption.
  - name: Signed contracts
    description: >-
      Contracts signed on an adoption, a foster placement or an intake, each
      kept exactly as it read when it was signed.
  - name: Contract templates
    description: >-
      The contracts your organization has people sign, with the merge fields
      that fill them in.
  - name: Reconciliations
    description: >-
      A payment processor's settlement lines, matched against the adoption
      payments you recorded.
  - name: Animal custom fields
    description: >-
      The extra fields your organization adds to animals, housing units and
      adoption applications.
  - name: Age groups
    description: >-
      What counts as a baby, an adult or a senior, per species, which fee rules
      and discounts read.
  - name: Animal statuses
    description: >-
      Your organization's status vocabulary for animal records, and what kind of
      status each one is.
  - name: Application stages
    description: >-
      The steps an adoption or foster application moves through before it is
      decided, in your organization's words.
  - name: Behaviour attributes
    description: >-
      The catalogue of behavioural traits, and where a trait with each name may
      be shown beyond the record.
  - name: Cage card templates
    description: >-
      The layouts your organization prints for the kennel door: paper, fields,
      photo and QR code.
  - name: Adoption fee schedules
    description: >-
      The rules that suggest an animal's adoption fee, and the discounts laid
      over them.
  - name: Medical catalogue
    description: >-
      The diagnoses, tests, vaccines, treatments, procedures, conditions and
      medications your medical records pick from.
  - name: People
    description: >-
      The people your organization deals with: adopters, donors, volunteers,
      fosters and everybody else.
  - name: Person notes
    description: Notes written on a person's record.
  - name: Person contacts
    description: >-
      A person's phone numbers and email addresses, one of each kind marked
      primary.
  - name: Person addresses
    description: A person's addresses, one of them primary.
  - name: Person tags
    description: Free-text labels on a person, added and removed one at a time.
  - name: People duplicates
    description: People who look like the same person entered twice, and merging them.
  - name: People custom fields
    description: The fields a person's record carries beyond the standard ones.
  - name: Organizations
    description: >-
      The outside organizations your rescue deals with: veterinary practices,
      partner rescues, shelters, suppliers, employers and agencies.
  - name: Organization locations
    description: An organization's places, one of them the main one.
  - name: Affiliations
    description: >-
      Who works at, volunteers for or otherwise belongs to an organization, now
      or in the past.
  - name: Forms
    description: >-
      The forms your organization publishes, such as an adoption application or
      a volunteer sign-up, and the questions on them.
  - name: Submissions
    description: >-
      What people sent through your forms, and what your team does with each
      one.
  - name: Tasks
    description: >-
      To-dos, on a record or for the whole organization, narrowed to the records
      your key may read.
  - name: Calendar
    description: >-
      The dated work across your organization in one list, narrowed to the areas
      your key may read.
  - name: Activity
    description: >-
      What was created, changed and deleted in your organization, narrowed to
      the areas your key may read.
  - name: Shift schedules
    description: >-
      Schedules: the occasions shifts are grouped under, such as an adoption day
      or Saturday kennel cover.
  - name: Shift windows
    description: >-
      Shifts: a stretch of time at a place, with the volunteer roles it needs
      and how many of each (the address calls a shift a window).
  - name: Shift bookings
    description: >-
      Sign-ups: a person taking a role on a shift, giving it up, and the hours
      they worked.
  - name: Volunteers
    description: >-
      The people who volunteer: where each stands, what they have done, and
      where they would rather work.
  - name: Volunteer roles
    description: >-
      The jobs a volunteer can sign up for, such as Dog walker or Adoption
      counselor.
  - name: Volunteer qualifications
    description: 'Approvals: who may take which role, and at which location.'
  - name: Shift policies
    description: The rules you set for sign-ups and cancellations.
  - name: Shift calendar
    description: Schedules and shifts as calendar items for a date range.
  - name: Shift custom fields
    description: Your own fields on schedules, shifts and sign-ups.
  - name: Events
    description: >-
      The occasions your rescue hosts: adoption days, fundraisers, clinics and
      the rest.
  - name: Events calendar
    description: Your events between two days, as calendar entries.
  - name: Campaigns
    description: >-
      Appeals you raise money for, each with its goal and what it has raised so
      far.
  - name: Donations
    description: 'Gifts of money: how much, from whom, and what they were given to.'
  - name: Donors
    description: The people who have given, with what each has given in all.
  - name: Wish list
    description: The things your rescue needs, and the deliveries that met them.
  - name: Fundraising custom fields
    description: Your organization's own fields on donations and campaigns.
  - name: Message templates
    description: >-
      Saved wording your organization sends again and again, with merge fields
      filled from your records.
  - name: Sending
    description: >-
      Everything here sends real email from your organization, and none of it
      can be unsent.
  - name: Message log
    description: >-
      The email your organization has sent or tried to send, and what became of
      each message.
  - name: Conversations
    description: >-
      The email conversations in your organization's inboxes, and the records
      each one is about.
  - name: Inboxes
    description: >-
      The addresses your organization receives email at, and who may read each
      one.
  - name: Contact preferences
    description: >-
      Whether a person has asked not to be emailed, altogether or about one kind
      of message.
  - name: Suppressions
    description: >-
      Addresses no email goes to, because mail to them bounced or their owner
      asked not to be written to.
  - name: Sender and deliverability
    description: Who your organization's email goes out as, and how much of it arrives.
  - name: Registry flags
    description: >-
      Safety flags your organization files about a person or an animal, which
      other organizations using RescueConsole can see once the flag is vetted
      and shared.
  - name: Registry reviews
    description: >-
      Another organization's vote on a flag it did not file, which decides
      whether the flag becomes active or disputed.
  - name: Registry search
    description: >-
      The lookup by microchip number that anybody may make, with or without a
      key.
paths:
  /api/animals/animals/{id}/medical/{recordId}:
    parameters:
      - name: id
        in: path
        required: true
        description: The animal's record ID (not its Pet ID).
        schema:
          type: string
      - name: recordId
        in: path
        required: true
        description: The medical record's ID.
        schema:
          type: string
    patch:
      tags:
        - Animal medical records
      summary: Change a medical record
      description: >-
        Changes a record: a test's result, a diagnosis's notes, a new date. Its
        task moves with it, and is marked done when the record is. To mark a
        scheduled record done and make the next of a series, complete it
        instead. Needs **write** on Animals.
      operationId: updateAnimalMedicalRecord
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnimalMedicalRecordUpdate'
            example:
              result_status: negative
              notes: Negative on both.
      responses:
        '200':
          description: The record, as it now is.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnimalMedicalRecord'
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/Problem'
components:
  schemas:
    AnimalMedicalRecordUpdate:
      type: object
      description: >-
        Send only what changes. Null clears a date, the notes, the booked time,
        the practice, the vet, the catalogue item, the result or the details.
        The record type, the recurrence, the medication and the prescription
        cannot be changed here.
      properties:
        name:
          type: string
          description: Cannot be blank.
        performed_on:
          type:
            - string
            - 'null'
          format: date
          description: The date it was done. Leave it out for something still to do.
        due_on:
          type:
            - string
            - 'null'
          format: date
          description: >-
            The date it is due. A record with a due_on and no performed_on is
            scheduled, and a task is made for it, assigned to whoever will do
            it.
        notes:
          type:
            - string
            - 'null'
        performed_by_person_id:
          type:
            - string
            - 'null'
          description: >-
            Who did it, or will: a person on file. The person who made the key,
            unless you say.
        performed_in_house:
          type:
            - boolean
            - 'null'
          description: >-
            Done at your own clinic. A record done in house names no
            veterinary_practice_id.
        veterinary_practice_id:
          type:
            - string
            - 'null'
          description: 'Where it was done: an organization on file.'
        veterinarian_person_id:
          type:
            - string
            - 'null'
          description: 'The vet: a person on file.'
        catalogue_item_id:
          type:
            - string
            - 'null'
          description: >-
            An item from your medical catalogue, of the kind the record type
            takes: a diagnosis for a condition, a test for a test, a vaccine for
            a vaccination, a treatment for a treatment, a procedure for a
            procedure. The other record types take none.
        result_status:
          type:
            - string
            - 'null'
          enum:
            - pending
            - normal
            - abnormal
            - positive
            - negative
            - inconclusive
            - null
          description: A test's outcome. Refused on any other record type.
        details:
          type: object
          additionalProperties: true
          description: >-
            Replaced whole. The record's own fields. For a vaccination,
            treatment, exam or procedure, and for any record made from a
            catalogue item, each key must be one of its fields, and each value
            that field's kind: text, a number, true or false, a YYYY-MM-DD date,
            an HH:MM time, or one of a list's options. A vaccination's fields
            include lot_number, product_expires_on, method and site; a
            procedure's include will_alter. Other records keep short text,
            numbers or true or false under keys of your own.
        due_start_at:
          type:
            - string
            - 'null'
          format: date-time
          description: The time it is booked for. Needs a due_on.
        duration_minutes:
          type:
            - integer
            - 'null'
          description: >-
            How long it is booked for, from 5 to 1,440 minutes. An hour when you
            give a start time and no length.
          minimum: 5
          maximum: 1440
    AnimalMedicalRecord:
      type: object
      properties:
        id:
          type: string
        record_type:
          type: string
          enum:
            - vaccination
            - treatment
            - procedure
            - test
            - medication
            - exam
            - condition
            - preventative
        name:
          type: string
        performed_on:
          type:
            - string
            - 'null'
          format: date
        due_on:
          type:
            - string
            - 'null'
          format: date
        notes:
          type:
            - string
            - 'null'
        performed_by_person_id:
          type:
            - string
            - 'null'
        recurrence_interval:
          type:
            - integer
            - 'null'
          description: How many units apart a recurring record falls.
        recurrence_unit:
          type:
            - string
            - 'null'
          enum:
            - day
            - week
            - month
            - year
            - null
        series_id:
          type:
            - string
            - 'null'
          description: >-
            The first record of a recurring series, shared by every record in
            it.
        recurrence_ended_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the series was stopped.
        veterinary_practice_id:
          type:
            - string
            - 'null'
        veterinarian_person_id:
          type:
            - string
            - 'null'
        medication_id:
          type:
            - string
            - 'null'
        refills_remaining:
          type:
            - integer
            - 'null'
          description: Refills left. Null is not tracked, which is different from 0.
        prescription_expires_on:
          type:
            - string
            - 'null'
          format: date
        catalogue_item_id:
          type:
            - string
            - 'null'
        result_status:
          type:
            - string
            - 'null'
          enum:
            - pending
            - normal
            - abnormal
            - positive
            - negative
            - inconclusive
            - null
        details:
          type: object
          additionalProperties: true
        performed_in_house:
          type: boolean
        due_start_at:
          type:
            - string
            - 'null'
          format: date-time
        duration_minutes:
          type:
            - integer
            - 'null'
        task_id:
          type:
            - string
            - 'null'
          description: The task made for it while it was scheduled.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        performed_by_name:
          type:
            - string
            - 'null'
          description: In the list only.
        veterinarian_name:
          type:
            - string
            - 'null'
          description: In the list only.
        veterinary_practice_name:
          type:
            - string
            - 'null'
          description: In the list only.
  responses:
    Problem:
      description: What is wrong, in one sentence you can show to a person.
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                type: string
          example:
            error: house_trained must be 1, 0 or null (not assessed)
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: An API key from Settings, API keys. It starts with rc_live_.

````