XdsObjects Help file
XdsObjects Namespace / XdsDocument Class
Properties Methods


In This Topic
    XdsDocument Class Members
    In This Topic

    The following tables list the members exposed by XdsDocument.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded. Create a new XdsDocument object  
    Top
    Public Properties
     NameDescription
    Public Property A flag indicating whether the document already exists in the registry (as opposed to being created now)  
    Public PropertyThe humans and/or machines that authored the document  
    Public PropertyThe availability stats (Approved/Deprecated) of the document  
    Public PropertyThe AvailabilityStatus as an integer  
    Public PropertyThe code specifying the particular kind of document  
    Public Property Comments associated with the Document  
    Public PropertyThe code(s) specifying the level of confidentiality of the XDS Document  
    Public PropertyThe time the author created the document in the Document Source.  
    Public Property The contents of the document  
    Public Property The Relationship between Existing (Parent) Document and Current Document being Submitted  
    Public PropertyThe code(s) representing the main clinical acts, such as a colonoscopy or an appendectomy, being documented.  
    Public Property The list of slots not explicitly used to populate other fields  
    Public PropertyCode globally uniquely specifying the format of the document.  
    Public PropertyHash key of the XDS Document itself.  
    Public PropertyThis code represents the type of organizational setting of the clinical encounter during which the documented act occurred.  
    Public PropertyThe HomeCommunityID of the Document  
    Public Property Indicates if the XdsDocument is of type On-Demand. Default value is false, which means it's of stable document type  
    Public PropertySpecifies the human language of character data in the document.  
    Public Property Represents a participant who has legally authenticated or attested the document within the authorInstitution.  
    Public Property Indicates whether the Document was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source Actor  
    Public Property To allow a collection of registry objects to be grouped together and be identified as versions of the same object, two new attributes are introduced: the Logical ID and the VersionInfo element. While all objects must have unique value for their id attribute to maintain their identity, all objects that are versions of the same logical object have the same logical id or lid attribute  
    Public PropertyMIME type of the document in the Repository.  
    Public PropertyShortcut to PatientInfo.XdsPerson.CompositeId  
    Public PropertyThe subject of care of the document.  
    Public PropertyThe code specifying the clinical specialty where the act that resulted in the document was performed  
    Public Property Set this property in the UpdateDocumentSet transaction  
    Public Property Holds a list of additional Reference ID name/value pairs  
    Public Property The globally unique identifier of the repository where the document is stored  
    Public Property Represents the start time the service being documented took place  
    Public Property Represents the stop time the service being documented took place  
    Public PropertySize of the XDS Document itself.  
    Public Property The details of the subject of care as the Document Source knew them at the time of Submission.  
    Public Property Represents the title of the document  
    Public Property The code specifying the precise kind of document  
    Public Property The globally unique identifier assigned by the document creator to this document.  
    Public PropertyThe URI from which the document could be retrieved.  
    Public PropertyThe globally unique identifier of the document  
    Public Property To allow a collection of registry objects to be grouped together and be identified as versions of the same object, two new attributes are introduced: the Logical ID and the VersionInfo element. While all objects must have unique value for their id attribute to maintain their identity, all objects that are versions of the same logical object have the same logical id or lid attribute  
    Top
    Public Methods
     NameDescription
    Public MethodCheck that the document in the Data property actually matches the Size and Hash values.  
    Public Methodstatic (Shared in Visual Basic) Deserialization of a Document  
    Public Methodstatic (Shared in Visual Basic)Creates a "dummy" XdsDocument object, in which only the UUID is populated, and the AlreadyExists property is true.  
    Public MethodOverloaded. Methods to load a XdsDocument directly from local resources  
    Public Method Serialize a XdsDocument  
    Public MethodSet the Size and Hash, based on the current content  
    Top
    See Also