@welshare/sdk
    Preparing search index...

    Interface CreateDocumentReferenceParams

    interface CreateDocumentReferenceParams {
        author?: string;
        binaryId: string;
        category?: {
            coding?: {
                code?: string;
                display?: string;
                system: string;
                userSelected?: boolean;
                version?: string;
            }[];
            text?: string;
        }[];
        description?: string;
        fileName: string;
        fileSize: number;
        fileType: string;
        subjectDid: string;
        type?: {
            coding?: {
                code?: string;
                display?: string;
                system: string;
                userSelected?: boolean;
                version?: string;
            }[];
            text?: string;
        };
    }
    Index

    Properties

    author? binaryId category? description? fileName fileSize fileType subjectDid type?

    Properties

    author?: string

    Author reference. If not provided, defaults to using the subject as author.

    binaryId: string

    The Binary resource ID (from BinaryFileSubmission._id)

    category?: {
        coding?: {
            code?: string;
            display?: string;
            system: string;
            userSelected?: boolean;
            version?: string;
        }[];
        text?: string;
    }[]

    Document categories. Use DOCUMENT_CATEGORY_CONCEPTS from standard-codes.ts.

    [DOCUMENT_CATEGORY_CONCEPTS.PERSONAL]
    description?: string

    Human-readable description/title. Defaults to fileName if not provided

    fileName: string

    Original file name

    fileSize: number

    File size in bytes

    fileType: string

    MIME type of the file

    subjectDid: string

    DID of the user who owns the document (subject)

    type?: {
        coding?: {
            code?: string;
            display?: string;
            system: string;
            userSelected?: boolean;
            version?: string;
        }[];
        text?: string;
    }

    Document type. Use DOCUMENT_TYPE_CONCEPTS from standard-codes.ts.

    DOCUMENT_TYPE_CONCEPTS.PHOTO_DOCUMENT

    Settings

    Member Visibility

    On This Page

    Properties