Document
A document file that contains an attachment and information about the attachment
Fields
can_only_share
· Boolean · When true, the user cannot adjust settings for the document besides sharing. created_at
· ISO8601DateTime!
· required · The date the document was made available to the given client description
· String · The description of the document display_name
· String · The display name of the document expiring_url
· String · A URL to download the file, good for 10 seconds file_content_type
· String · The file type of the document form_answer_groups
· [FormAnswerGroup!] · The form answer groups associated with this document friendly_type
· String · The file extension in human-readable format e.g.: 'Video'/'Audio'/'Excel' etc internal_notes
· String · Notes on the document (not visible to the client) opens
· [DocumentViewing!] · Instances of the document being viewed/opened rel_user_id
· ID · ID of the assigned client shareable_org_members
· UserConnection · The organization members who may have access to the shareable record shareable_patients
· UserConnection · The patients who may have access to the shareable record shareable_user_groups
· UserGroupPaginationConnection · The user groups that may have access to the shareable record shared_user_groups_count
· Int · The number of user groups who the document is shared shared_users_count
· Int · The number of users who the document is directly shared with (not through groups) Used By
Definition
"""A document file that contains an attachment and information about the attachment"""type Document { """ When true, the user cannot adjust settings for the document besides sharing. """ can_only_share: Boolean
""" The date the document was made available to the given client """ created_at( """ The custom ID of viewable user (default: current user) """ viewable_user_id: String ): ISO8601DateTime!
""" Pagination cursor """ cursor: Cursor!
""" The description of the document """ description: String
""" The display name of the document """ display_name: String
""" Include the file in new clients welcome email """ email_on_welcome: Boolean!
""" A URL to download the file, good for 10 seconds """ expiring_url: String
""" The extension of the document """ extension: String
""" The file type of the document """ file_content_type: String
""" The form answer groups associated with this document """ form_answer_groups: [FormAnswerGroup!]
""" The file extension in human-readable format e.g.: 'Video'/'Audio'/'Excel' etc """ friendly_type: String
""" The unique idenitifer of the document """ id: ID!
""" Include the document within the private charts section """ include_in_charting: Boolean!
""" Notes on the document (not visible to the client) """ internal_notes: String
""" A serialized JSON string of metadata. Maximum character limit of 128,000. Only accessible by staff and providers """ metadata: String
""" Instances of the document being viewed/opened """ opens: [DocumentViewing!]
""" Owner of this document """ owner: User
""" In the case of a private document, the user that this document is for """ rel_user: User
""" ID of the assigned client """ rel_user_id: ID
""" The organization members who may have access to the shareable record """ shareable_org_members( """ Returns the elements in the list that come after the specified cursor. """ after: String
""" Returns the elements in the list that come before the specified cursor. """ before: String
""" Returns the first _n_ elements from the list. """ first: Int
""" Returns the last _n_ elements from the list. """ last: Int
""" Search patients by name, identifiers, email, DOB, or NPI """ keywords: String order_by: UserOrderKeys = LAST_NAME_ASC
""" Filter on organization members that are either already shared or unshared """ shared: Boolean ): UserConnection
""" The patients who may have access to the shareable record """ shareable_patients( """ Returns the elements in the list that come after the specified cursor. """ after: String
""" Returns the elements in the list that come before the specified cursor. """ before: String
""" Returns the first _n_ elements from the list. """ first: Int
""" Returns the last _n_ elements from the list. """ last: Int
""" Search patients by name, identifiers, email, or DOB """ keywords: String order_by: UserOrderKeys = LAST_NAME_ASC
""" Filter on patients that are either already shared or unshared """ shared: Boolean ): UserConnection
""" The user groups that may have access to the shareable record """ shareable_user_groups( """ Returns the elements in the list that come after the specified cursor. """ after: String
""" Returns the elements in the list that come before the specified cursor. """ before: String
""" Returns the first _n_ elements from the list. """ first: Int
""" Returns the last _n_ elements from the list. """ last: Int
""" Search user groups by name """ keywords: String order_by: UserGroupOrderKeys = NAME_ASC
""" Filter on user groups that are either already shared or unshared """ shared: Boolean ): UserGroupPaginationConnection
""" The document shared """ shared: Boolean
""" Share the file with new clients automatically """ shared_on_welcome: Boolean!
""" The number of user groups who the document is shared """ shared_user_groups_count: Int
""" The number of users who the document is directly shared with (not through groups) """ shared_users_count: Int
""" Share with all members of the organization """ shared_with_dietitians: Boolean!
""" The date the document was updated """ updated_at: ISO8601DateTime!
""" The user groups who have access to this document """ user_groups: [UserGroup!]!
""" The users who have access to this document """ users( """ Cursor to fetch results after """ after: Cursor should_paginate: Boolean = false page_size: Int = 100 order_by: UserOrderKeys = LAST_NAME_ASC ): [User!]!
""" The number of users who have access to this document """ users_count: Int!}