Skip to main content

Document

@icure/medical-device-sdk / Document

Class: Document

ICure Medical Device Micro Service ICure Medical Device Micro Service

OpenAPI spec version: v2

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

Table of contents​

Constructors​

Properties​

Methods​

Constructors​

constructor​

• new Document(json)

Parameters​

NameType
jsonIDocument

Defined in​

src/models/Document.ts:15

Properties​

attachmentId​

• Optional attachmentId: string

Id of attachment to this document

Defined in​

src/models/Document.ts:72

author​

• Optional author: string

Defined in​

src/models/Document.ts:33

created​

• Optional created: number

Defined in​

src/models/Document.ts:31

deletionDate​

• Optional deletionDate: number

Defined in​

src/models/Document.ts:36

externalUuid​

• Optional externalUuid: string

A unique external id (from another external source).

Defined in​

src/models/Document.ts:60

hash​

• Optional hash: string

Hashed version of the document

Defined in​

src/models/Document.ts:68

id​

• Optional id: string

The Id of the document. We encourage using either a v4 UUID or a HL7 Id.

Defined in​

src/models/Document.ts:26

mainUti​

• Optional mainUti: string

The main Uniform Type Identifier of the document (https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/understanding_utis/understand_utis_conc/understand_utis_conc.html#//apple_ref/doc/uid/TP40001319-CH202-CHDHIJDE)

Defined in​

src/models/Document.ts:44

medicalLocationId​

• Optional medicalLocationId: string

Defined in​

src/models/Document.ts:35

modified​

• Optional modified: number

Defined in​

src/models/Document.ts:32

name​

• Optional name: string

Name of the document

Defined in​

src/models/Document.ts:48

objectStoreReference​

• Optional objectStoreReference: string

Reference in object store

Defined in​

src/models/Document.ts:40

otherUtis​

• otherUtis: Set<string>

Extra Uniform Type Identifiers

Defined in​

src/models/Document.ts:56

responsible​

• Optional responsible: string

Defined in​

src/models/Document.ts:34

rev​

• Optional rev: string

The revision of the document in the database, used for conflict management / optimistic locking.

Defined in​

src/models/Document.ts:30

size​

• Optional size: number

Size of the document file

Defined in​

src/models/Document.ts:64

version​

• Optional version: string

The document version

Defined in​

src/models/Document.ts:52

Methods​

marshal​

▸ marshal(): IDocument

Returns​

IDocument

Defined in​

src/models/Document.ts:74