OBJECT
Document
A document file that contains an attachment and information about the attachment
link GraphQL Schema definition
- type Document {
- # When true, the user cannot adjust settings for the document besides sharing.
- Boolean :
- # The date the document was made available to the given client
- #
- # Arguments
- # viewable_user_id: The custom ID of viewable user (default:
- # current user)
- String): String! ( :
- # Pagination cursor
- Cursor! :
- # The description of the document
- String :
- # The display name of the document
- String :
- # Include the file in new clients welcome email
- Boolean! :
- # A URL to download the file, good for 10 seconds
- String :
- # The extension of the document
- String :
- # The file type of the document
- String :
- # The file extension in human-readable format e.g.: 'Video'/'Audio'/'Excel' etc
- String :
- # The unique idenitifer of the document
- ID! :
- # Include the document within the private charts section
- Boolean! :
- # Notes on the document (not visible to the client)
- String :
- # A serialized JSON string of metadata. Maximum character limit of 128,000. Only
- # accessible by staff and providers
- String :
- # Instances of the document being viewed/opened
- DocumentViewing!] : [
- # Owner of this document
- User :
- # In the case of a private document, the user that this document is for
- User :
- # ID of the assigned client
- ID :
- # The document shared
- Boolean :
- # Share the file with new clients automatically
- Boolean! :
- # The number of user groups who the document is shared
- Int :
- # The number of users who the document is directly shared with (not through
- # groups)
- Int :
- # Share with all members of the organization
- Boolean! :
- # The date the document was updated
- String! :
- # The user groups who have access to this document
- UserGroup!]! : [
- # The users who have access to this document
- User!]! : [
- }
link Require by
- CarePlanA Care Plan
- ChartingItemTypeCharting Item
- createDocumentPayloadAutogenerated return type of createDocument.
- deleteDocumentPayloadAutogenerated return type of deleteDocument.
- LabOrderLab Order Object
- LabResultLab Result
- QueryThe query root of this schema. See available queries.
- shareAnswersAsDocumentPayloadAutogenerated return type of shareAnswersAsDocument.
- updateDocumentPayloadAutogenerated return type of updateDocument.