Leadtools.Dicom Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
SetEncapsulatedDocument Method
See Also  Example
Leadtools.Dicom Namespace > DicomDataSet Class : SetEncapsulatedDocument Method



element
A DicomElement in the data set.
child
true to insert the encapsulated document as a child of element., false to insert the encapsulated document on the same level as element.
fileDocument
The name of the file that will be encapsulated.
encapsulatedDocument
The encapsulated document module attributes
conceptNameCodeSequence
The concept name code sequence attributes
element
A DicomElement in the data set.
child
true to insert the encapsulated document as a child of element., false to insert the encapsulated document on the same level as element.
fileDocument
The name of the file that will be encapsulated.
encapsulatedDocument
The encapsulated document module attributes
conceptNameCodeSequence
The concept name code sequence attributes
Inserts an encapsulated document and corresponding DICOM elements into a DICOM data set.

Syntax

Visual Basic (Declaration) 
Public Sub SetEncapsulatedDocument( _
   ByVal element As DicomElement, _
   ByVal child As Boolean, _
   ByVal fileDocument As String, _
   ByVal encapsulatedDocument As DicomEncapsulatedDocument, _
   ByVal conceptNameCodeSequence As DicomCodeSequenceItem _
)
Visual Basic (Usage)Copy Code
Dim instance As DicomDataSet
Dim element As DicomElement
Dim child As Boolean
Dim fileDocument As String
Dim encapsulatedDocument As DicomEncapsulatedDocument
Dim conceptNameCodeSequence As DicomCodeSequenceItem
 
instance.SetEncapsulatedDocument(element, child, fileDocument, encapsulatedDocument, conceptNameCodeSequence)
C++/CLI 
public:
void SetEncapsulatedDocument( 
   DicomElement^ element,
   bool child,
   String^ fileDocument,
   DicomEncapsulatedDocument^ encapsulatedDocument,
   DicomCodeSequenceItem^ conceptNameCodeSequence
)

Parameters

element
A DicomElement in the data set.
child
true to insert the encapsulated document as a child of element., false to insert the encapsulated document on the same level as element.
fileDocument
The name of the file that will be encapsulated.
encapsulatedDocument
The encapsulated document module attributes
conceptNameCodeSequence
The concept name code sequence attributes

Example

Visual BasicCopy Code
'''
Private Sub DicomDataSet_SetEncapsulatedDocumentExample(ByVal element As DicomElement, ByVal child As Boolean, ByVal ds As DicomDataSet, ByVal sFileDocumentIn As String)
   Dim encapsulatedDocument As DicomEncapsulatedDocument = New DicomEncapsulatedDocument()
   encapsulatedDocument.Type = DicomEncapsulatedDocumentType.Pdf
   encapsulatedDocument.InstanceNumber = 123
   encapsulatedDocument.ContentDate = New DicomDateValue(2008, 12, 31)

   encapsulatedDocument.ContentTime = New DicomTimeValue(12, 30, 0, 1)

   encapsulatedDocument.AcquisitionDateTime = New DicomDateTimeValue(2008, 12, 31, 12, 30, 0, 1, -3)

   encapsulatedDocument.BurnedInAnnotation = "YES"
   encapsulatedDocument.DocumentTitle = sFileDocumentIn
   encapsulatedDocument.VerificationFlag = "UNVERIFIED"
   encapsulatedDocument.HL7InstanceIdentifier = String.Empty

   ' The 'pszMIMETypeOfEncapsulatedDocument' field is ignored when calling SetEncapsulatedDocument
   ' It is filled in when calling 'SetEncapsulatedDocument'
   encapsulatedDocument.MimeTypeOfEncapsulatedDocument = "***** This is ignored when calling SetEncapsulatedDocument *****"

   Dim sListOfMimeTypes As String() = New String() {"image/jpeg", "application/pdf"}
   encapsulatedDocument.SetListOfMimeTypes(sListOfMimeTypes)
   'encapsulatedDocument.nListOfMIMETypesCount = 2;

   Dim conceptNameCodeSequence As DicomCodeSequenceItem = New DicomCodeSequenceItem()
   conceptNameCodeSequence.CodingSchemeDesignator = "LN"
   conceptNameCodeSequence.CodeValue = "12345"
   conceptNameCodeSequence.CodeMeaning = "Sample Code Meaning"

   ds.SetEncapsulatedDocument(element, child, sFileDocumentIn, encapsulatedDocument, conceptNameCodeSequence)
End Sub
C#Copy Code
///  
void DicomDataSet_SetEncapsulatedDocumentExample(DicomElement element, bool child, DicomDataSet ds, string sFileDocumentIn) 
{ 
   DicomEncapsulatedDocument encapsulatedDocument = new DicomEncapsulatedDocument(); 
   encapsulatedDocument.Type = DicomEncapsulatedDocumentType.Pdf; 
   encapsulatedDocument.InstanceNumber = 123; 
   encapsulatedDocument.ContentDate = new DicomDateValue(2008, 12, 31); 
 
   encapsulatedDocument.ContentTime = new DicomTimeValue(12, 30, 00, 1); 
 
   encapsulatedDocument.AcquisitionDateTime = new DicomDateTimeValue(2008, 12, 31, 12, 30, 00, 01, -3); 
 
   encapsulatedDocument.BurnedInAnnotation = "YES"; 
   encapsulatedDocument.DocumentTitle = sFileDocumentIn; 
   encapsulatedDocument.VerificationFlag = "UNVERIFIED"; 
   encapsulatedDocument.HL7InstanceIdentifier = string.Empty; 
 
   // The 'pszMIMETypeOfEncapsulatedDocument' field is ignored when calling SetEncapsulatedDocument 
   // It is filled in when calling 'SetEncapsulatedDocument' 
   encapsulatedDocument.MimeTypeOfEncapsulatedDocument = "***** This is ignored when calling SetEncapsulatedDocument *****"; 
 
   string[] sListOfMimeTypes = new string[] { "image/jpeg", "application/pdf" }; 
   encapsulatedDocument.SetListOfMimeTypes(sListOfMimeTypes); 
   //encapsulatedDocument.nListOfMIMETypesCount               = 2; 
 
   DicomCodeSequenceItem conceptNameCodeSequence = new DicomCodeSequenceItem(); 
   conceptNameCodeSequence.CodingSchemeDesignator = "LN"; 
   conceptNameCodeSequence.CodeValue = "12345"; 
   conceptNameCodeSequence.CodeMeaning = "Sample Code Meaning"; 
 
   ds.SetEncapsulatedDocument(element, child, sFileDocumentIn, encapsulatedDocument, conceptNameCodeSequence); 
}

Remarks

This feature is available in version 16 or higher.

The members of the DicomEncapsulatedDocument class and the DicomCodeSequenceItem class together represent the set of attributes contained in the "Encapsulated Document Module Attributes”. The Encapsulated Information Object Definition (IOD) describes either a

  • PDF document
  • CDA document

that has been encapsulated within a DICOM information object. For more information, refer to Part 3 of the DICOM standard.

The encapsulatedDocument class corresponds to the Encapsulated Document Module Attributes described in part 3 of the DICOM specification. To set the Concept Name Code Sequence element (0040,A043) pass a conceptNameCodeSequence object.

fileDocument is a file location of the document that will be encapsulated. This should be either a PDF or a CDA document, and the member of the DicomEncapsulatedDocument class should be set accordingly.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Dicom requires a Medical toolkit server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features