JOjoincandidhealth
v1

Update

Changed on

Updates a note. The path must contain the most recent version to prevent races.

put/notes/v1/{id}/{version}

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/notes/v1/{id}/{version}
  • Auth
    HTTP bearer

Path parameters

idstring required

The unique identifier for a Note.

versionstring required

Request body

valuestring required
type'GENERAL' | 'ELIGIBILITY'

Distinguishes what a note is about. GENERAL = a plain patient note; ELIGIBILITY = a note regarding the patient's eligibility.

author_emailstring
author_namestring

Response

Response with status 200

organization_idstring required

The unique identifier for an Organization in the database

deactivatedboolean required

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

versioninteger required

The version of the object. Any update to any property of an object object will create a new version.

updated_atstring date-time required
updating_user_idstring required

The unique identifier for a User in the database

valuestring required
type'GENERAL' | 'ELIGIBILITY'

Distinguishes what a note is about. GENERAL = a plain patient note; ELIGIBILITY = a note regarding the patient's eligibility.

author_emailstring
author_namestring
idstring required

The unique identifier for a Note.

created_atstring date-time required

Changes

  • 24b2d80d577aRevision changes
    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      for the path request parameter id, the type was generalized from no type to string

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id update removed and replaced with v1_update_5