AuthorNote

Stores notes associated with different types of records along with information about the author of the note and the time the note was authored. The author isn’t necessarily the person who created a record. The author is the person who provided the information in the note. This object is available in API version 52.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

AuthorId

Type: Preference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: References the author of the note.

This is a polymorphic relationship field.
Relationship Name: Author
Relationship Type: Lookup
Referenced Objects:
- Account
- Contact
- HealthcareProvider
- User—This value is available in API version 55.0 and later.

AuthorName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The name of the author of the note.

AuthoredDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date and time when the note was authored.

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user referenced the record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user viewed the record.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The name of the AuthorNote record. This value is generated automatically.

NoteText

Type: textarea
Properties: Create, Update
Description: The contents of the note.

OwnerId

Type: Polymorphic reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The owner of the AuthorNote record.
Relationship Name: Owner
Relationship Type: Lookup
Referenced Objects: Group, User

ParentRecordId

Type: Polymorhpic reference
Properties: Create, Filter, Group, Sort, Update
Description: References the parent record that the note is associated with.
Referenced Objects:
- Account
- AllergyIntolerance
- CareObservation
- CareRegisteredDevice
- ClinicalDetectedIssue—This value is available in API version 55.0 and later.
- ClinicalServiceRequest
- HealthCondition
- MedicationRequest
- MedicationStatement
- PatientImmunization
- PatientMedicalProcedure

RecipientType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The type of recipient for an author note.

This field is available in API version 55.0 and later.
Possible values:
- Patient
- Provider

SourceSystem

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The name of the system the record came from.

SourceSystemIdentifier

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the record in its source system.

SourceSystemModified

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date and time when the record was last changed in the source system.

Usage

When a record requires a related note with the information about the author of that note, that information is stored in an AuthorNote record. This AuthorNote record references the parent record it’s associated with using the ParentRecordId field.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

AuthorNoteFeed: Feed tracking is available for the object.
AuthorNoteHistory: History is available for tracked fields of the object.
AuthorNoteShare: Sharing is available for the object.
AuthorNoteChangeEvent (API version 61.0): Change events are available for the object.