←Select platform

GetEncapsulatedDocument(DicomElement,bool,string,DicomEncapsulatedDocument,DicomCodeSequenceItem) Method

Summary

Retrieves an encapsulated document and corresponding DICOM elements from a DICOM data set and output the results to a disk file.

Syntax
C#
VB
C++
Java
public void GetEncapsulatedDocument( 
   DicomElement element, 
   bool child, 
   string fileDocument, 
   DicomEncapsulatedDocument encapsulatedDocument, 
   DicomCodeSequenceItem conceptNameCodeSequence 
) 
Public Overloads Sub GetEncapsulatedDocument( _ 
   ByVal element As DicomElement, _ 
   ByVal child As Boolean, _ 
   ByVal fileDocument As String, _ 
   ByVal encapsulatedDocument As DicomEncapsulatedDocument, _ 
   ByVal conceptNameCodeSequence As DicomCodeSequenceItem _ 
)  
public void getEncapsulatedDocument(DicomElement element, boolean child, String fileDocument, DicomEncapsulatedDocument encapsulatedDocument, DicomCodeSequenceItem conceptNameCodeSequence) 
public: 
void GetEncapsulatedDocument(  
   DicomElement^ element, 
   bool child, 
   String^ fileDocument, 
   DicomEncapsulatedDocument^ encapsulatedDocument, 
   DicomCodeSequenceItem^ conceptNameCodeSequence 
)

Parameters

element
A DicomElement in the data set.

child
true to retrieve the encapsulated document as a child of element., false to retrieve the encapsulated document on the same level as element.

fileDocument
The name of the file that will contain the encapsulated document.

encapsulatedDocument
The encapsulated document module attributes

conceptNameCodeSequence
The concept name code sequence attributes

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 retrieve the Concept Name Code Sequence element (0040,A043) pass a conceptNameCodeSequence object.

fileDocument is a file location that will contain the encapsulated document after it is extracted. If this file already exists, it will be over written.

Example
C#
VB
using Leadtools; 
using Leadtools.Dicom; 
 
///  
void DumpEncapsulatedDocumentTags(string sMsgIn, DicomEncapsulatedDocument encapsulatedDocument, DicomCodeSequenceItem conceptNameCodeSequence) 
{ 
   string sMimeTypes = string.Empty; 
   string[] sListOfMimeTypes = encapsulatedDocument.GetListOfMimeTypes(); 
   foreach (string s in sListOfMimeTypes) 
      sMimeTypes = sMimeTypes + s + ","; 
   string sMsg1 = string.Format("{0}\n\nuType: {1}\n" + 
                                "InstanceNumber: {2}\n" + 
                                "ContentDate: {3}\n" + 
                                "ContentTime: {4}\n" + 
                                "AcquisitionDateTime: {5}\n" + 
                                "BurnedInAnnotation: {6}\n" + 
                                "DocumentTitle: {7}\n" + 
                                "VerificationFlag: {8}\n" + 
                                "HL7InstanceIdentifier: {9}\n" + 
                                "MIMETypeOfEncapsulatedDocument: {10}\n" + 
                                "ListOfMIMETypes: {11}\n\n", 
      sMsgIn, 
      encapsulatedDocument.Type.ToString(), 
      encapsulatedDocument.InstanceNumber, 
      encapsulatedDocument.ContentDate.ToString(), 
      encapsulatedDocument.ContentTime.ToString(), 
      encapsulatedDocument.AcquisitionDateTime.ToString(), 
      encapsulatedDocument.BurnedInAnnotation, 
      encapsulatedDocument.DocumentTitle, 
      encapsulatedDocument.VerificationFlag, 
      encapsulatedDocument.HL7InstanceIdentifier, 
      encapsulatedDocument.MimeTypeOfEncapsulatedDocument, 
      sMimeTypes 
      ); 
 
   // ConceptNameCodeSequence 
   string sMsg2 = string.Format("CodeValue: {0}\n" + 
                                "CodingSchemeDesignator: {1}\n" + 
                                "CodingSchemeVersion: {2}\n" + 
                                "CodeMeaning: {3}\n" + 
                                "ContextIdentifier: {4}\n" + 
                                "MappingResource: {5}\n" + 
                                "ContextGroupVersion: {6}\n" + 
                                "ContextGroupLocalVersion: {7}\n" + 
                                "ContextGroupExtensionCreatorUID: {8}", 
      conceptNameCodeSequence.CodeValue, 
      conceptNameCodeSequence.CodingSchemeDesignator, 
      conceptNameCodeSequence.CodingSchemeVersion, 
      conceptNameCodeSequence.CodeMeaning, 
      conceptNameCodeSequence.ContextIdentifier, 
      conceptNameCodeSequence.MappingResource, 
      conceptNameCodeSequence.ContextGroupVersion.ToString(), 
      conceptNameCodeSequence.ContextGroupLocalVersion.ToString(), 
      conceptNameCodeSequence.ContextGroupExtensionCreatorUID 
      ); 
 
   MessageBox.Show(sMsg1 + sMsg2); 
} 
void DicomDataSet_GetEncapsulatedDocumentExample(DicomElement element, bool child, DicomDataSet ds, string sFileDocumentOut) 
{ 
   DicomEncapsulatedDocument encapsulatedDocument = new DicomEncapsulatedDocument(); 
   DicomCodeSequenceItem conceptNameCodeSequence = new DicomCodeSequenceItem(); 
 
   ds.GetEncapsulatedDocument(element, child, sFileDocumentOut, encapsulatedDocument, conceptNameCodeSequence); 
   string sMsg = string.Format("Encapsulated Document Extracted: {0}", sFileDocumentOut); 
   DumpEncapsulatedDocumentTags(sMsg, encapsulatedDocument, conceptNameCodeSequence); 
 
   // We can also use the overload which takes a file stream 
   using (FileStream stream = new FileStream(sFileDocumentOut, FileMode.Create)) 
   { 
      ds.GetEncapsulatedDocument(element, child, stream, encapsulatedDocument, conceptNameCodeSequence); 
   } 
   sMsg = string.Format("Encapsulated Document Extracted from stream: {0}", sFileDocumentOut); 
   DumpEncapsulatedDocumentTags(sMsg, encapsulatedDocument, conceptNameCodeSequence); 
} 
Imports Leadtools 
Imports Leadtools.Dicom 
 
'''  
Private Sub DumpEncapsulatedDocumentTags(ByVal sMsgIn As String, ByVal encapsulatedDocument As DicomEncapsulatedDocument, 
                                         ByVal conceptNameCodeSequence As DicomCodeSequenceItem) 
   Dim sMimeTypes As String = String.Empty 
   Dim sListOfMimeTypes As String() = encapsulatedDocument.GetListOfMimeTypes() 
   For Each s As String In sListOfMimeTypes 
      sMimeTypes = sMimeTypes & s & "," 
   Next s 
   Dim sMsg1 As String = String.Format("{0}" & Constants.vbLf + Constants.vbLf & "uType: {1}" & Constants.vbLf & "InstanceNumber: {2}" & 
                                       Constants.vbLf & "ContentDate: {3}" & Constants.vbLf & "ContentTime: {4}" & Constants.vbLf & 
                                       "AcquisitionDateTime: {5}" & Constants.vbLf & "BurnedInAnnotation: {6}" & Constants.vbLf & "DocumentTitle: {7}" & 
                                       Constants.vbLf & "VerificationFlag: {8}" & Constants.vbLf & "HL7InstanceIdentifier: {9}" & Constants.vbLf & 
                                       "MIMETypeOfEncapsulatedDocument: {10}" & Constants.vbLf & "ListOfMIMETypes: {11}" & 
                                       Constants.vbLf + Constants.vbLf, sMsgIn, encapsulatedDocument.Type.ToString(), 
                                       encapsulatedDocument.InstanceNumber, encapsulatedDocument.ContentDate.ToString(), 
                                       encapsulatedDocument.ContentTime.ToString(), encapsulatedDocument.AcquisitionDateTime.ToString(), 
                                       encapsulatedDocument.BurnedInAnnotation, encapsulatedDocument.DocumentTitle, encapsulatedDocument.VerificationFlag, 
                                       encapsulatedDocument.HL7InstanceIdentifier, encapsulatedDocument.MimeTypeOfEncapsulatedDocument, sMimeTypes) 
 
   ' ConceptNameCodeSequence 
   Dim sMsg2 As String = String.Format("CodeValue: {0}" & Constants.vbLf & "CodingSchemeDesignator: {1}" & Constants.vbLf & "CodingSchemeVersion: {2}" & 
                                       Constants.vbLf & "CodeMeaning: {3}" & Constants.vbLf & "ContextIdentifier: {4}" & Constants.vbLf & "MappingResource: {5}" & 
                                       Constants.vbLf & "ContextGroupVersion: {6}" & Constants.vbLf & "ContextGroupLocalVersion: {7}" & Constants.vbLf & 
                                       "ContextGroupExtensionCreatorUID: {8}", conceptNameCodeSequence.CodeValue, conceptNameCodeSequence.CodingSchemeDesignator, 
                                       conceptNameCodeSequence.CodingSchemeVersion, conceptNameCodeSequence.CodeMeaning, conceptNameCodeSequence.ContextIdentifier, 
                                       conceptNameCodeSequence.MappingResource, conceptNameCodeSequence.ContextGroupVersion.ToString(), 
                                       conceptNameCodeSequence.ContextGroupLocalVersion.ToString(), conceptNameCodeSequence.ContextGroupExtensionCreatorUID) 
 
   MessageBox.Show(sMsg1 & sMsg2) 
End Sub 
Private Sub DicomDataSet_GetEncapsulatedDocumentExample(ByVal element As DicomElement, ByVal child As Boolean, ByVal ds As DicomDataSet, 
                                                        ByVal sFileDocumentOut As String) 
   Dim encapsulatedDocument As DicomEncapsulatedDocument = New DicomEncapsulatedDocument() 
   Dim conceptNameCodeSequence As DicomCodeSequenceItem = New DicomCodeSequenceItem() 
 
   ds.GetEncapsulatedDocument(element, child, sFileDocumentOut, encapsulatedDocument, conceptNameCodeSequence) 
   Dim sMsg As String 
   sMsg = String.Format("Encapsulated Document Extracted: {0}", sFileDocumentOut) 
   DumpEncapsulatedDocumentTags(sMsg, encapsulatedDocument, conceptNameCodeSequence) 
 
   ' We can also use the overload which takes a file stream 
   Using stream As New FileStream(sFileDocumentOut, FileMode.Create) 
      ds.GetEncapsulatedDocument(element, child, stream, encapsulatedDocument, conceptNameCodeSequence) 
   End Using 
   sMsg = String.Format("Encapsulated Document Extracted from stream: {0}", sFileDocumentOut) 
   DumpEncapsulatedDocumentTags(sMsg, encapsulatedDocument, conceptNameCodeSequence) 
End Sub 
c#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Dicom; 
using Leadtools.Examples; 
 
void DicomDataSet_GetEncapsulatedDocumentExample(DicomElement element, bool child, DicomDataSet ds, Stream outputStream) 
{ 
   DicomEncapsulatedDocument encapsulatedDocument = new DicomEncapsulatedDocument(); 
   DicomCodeSequenceItem conceptNameCodeSequence = new DicomCodeSequenceItem(); 
 
   ds.GetEncapsulatedDocument(element, child, outputStream, encapsulatedDocument, conceptNameCodeSequence); 
   string sMsg; 
   sMsg = string.Format("Encapsulated Document Extracted."); 
   DumpEncapsulatedDocumentTags(sMsg, encapsulatedDocument, conceptNameCodeSequence); 
} 
void DumpEncapsulatedDocumentTags(string sMsgIn, DicomEncapsulatedDocument encapsulatedDocument, DicomCodeSequenceItem conceptNameCodeSequence) 
{ 
   string sMimeTypes = string.Empty; 
   string[] sListOfMimeTypes = encapsulatedDocument.GetListOfMimeTypes(); 
   foreach (string s in sListOfMimeTypes) 
      sMimeTypes = sMimeTypes + s + ","; 
   string sMsg1 = string.Format("{0}\n\nuType: {1}\nInstanceNumber: {2}\n" + 
                                "ContentDate: {3}\n" + 
                                "ContentTime: {4}\n" + 
                                "AcquisitionDateTime: {5}\n" + 
                                "BurnedInAnnotation: {6}\n" + 
                                "DocumentTitle: {7}\n" + 
                                "VerificationFlag: {8}\n" + 
                                "HL7InstanceIdentifier: {9}\n" + 
                                "MIMETypeOfEncapsulatedDocument: {10}\n" + 
                                "ListOfMIMETypes: {11}\n\n", 
      sMsgIn, 
      encapsulatedDocument.Type.ToString(), 
      encapsulatedDocument.InstanceNumber, 
      encapsulatedDocument.ContentDate.ToString(), 
      encapsulatedDocument.ContentTime.ToString(), 
      encapsulatedDocument.AcquisitionDateTime.ToString(), 
      encapsulatedDocument.BurnedInAnnotation, 
      encapsulatedDocument.DocumentTitle, 
      encapsulatedDocument.VerificationFlag, 
      encapsulatedDocument.HL7InstanceIdentifier, 
      encapsulatedDocument.MimeTypeOfEncapsulatedDocument, 
      sMimeTypes 
      ); 
 
   // ConceptNameCodeSequence 
   string sMsg2 = string.Format("CodeValue: {0}\n" + 
                                "CodingSchemeDesignator: {1}\n" + 
                                "CodingSchemeVersion: {2}\n" + 
                                "CodeMeaning: {3}\n" + 
                                "ContextIdentifier: {4}\n" + 
                                "MappingResource: {5}\n" + 
                                "ContextGroupVersion: {6}\n" + 
                                "ContextGroupLocalVersion: {7}\n" + 
                                "ContextGroupExtensionCreatorUID: {8}", 
      conceptNameCodeSequence.CodeValue, 
      conceptNameCodeSequence.CodingSchemeDesignator, 
      conceptNameCodeSequence.CodingSchemeVersion, 
      conceptNameCodeSequence.CodeMeaning, 
      conceptNameCodeSequence.ContextIdentifier, 
      conceptNameCodeSequence.MappingResource, 
      conceptNameCodeSequence.ContextGroupVersion.ToString(), 
      conceptNameCodeSequence.ContextGroupLocalVersion.ToString(), 
      conceptNameCodeSequence.ContextGroupExtensionCreatorUID 
      ); 
 
   Debug.WriteLine(sMsg1 + sMsg2); 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Dicom 
 
Private Sub DicomDataSet_GetEncapsulatedDocumentExample(ByVal element As DicomElement, 
                                                        ByVal child As Boolean, 
                                                        ByVal ds As DicomDataSet, 
                                                        ByVal outputStream As Stream) 
   Dim encapsulatedDocument As DicomEncapsulatedDocument = New DicomEncapsulatedDocument() 
   Dim conceptNameCodeSequence As DicomCodeSequenceItem = New DicomCodeSequenceItem() 
 
   ds.GetEncapsulatedDocument(element, child, outputStream, encapsulatedDocument, conceptNameCodeSequence) 
   Dim sMsg As String 
   sMsg = String.Format("Encapsulated Document Extracted.") 
   DumpEncapsulatedDocumentTags(sMsg, encapsulatedDocument, conceptNameCodeSequence) 
End Sub 
Private Sub DumpEncapsulatedDocumentTags(ByVal sMsgIn As String, 
                                         ByVal encapsulatedDocument As DicomEncapsulatedDocument, 
                                         ByVal conceptNameCodeSequence As DicomCodeSequenceItem) 
   Dim sMimeTypes As String = String.Empty 
   Dim sListOfMimeTypes As String() = encapsulatedDocument.GetListOfMimeTypes() 
   For Each s As String In sListOfMimeTypes 
      sMimeTypes = sMimeTypes & s & "," 
   Next s 
   Dim sMsg1 As String = String.Format("{0}" _ 
                                       & Constants.vbLf + Constants.vbLf _ 
                                       & "uType: {1}" & Constants.vbLf _ 
                                       & "InstanceNumber: {2}" _ 
                                       & Constants.vbLf _ 
                                       & "ContentDate: {3}" _ 
                                       & Constants.vbLf _ 
                                       & "ContentTime: {4}" _ 
                                       & Constants.vbLf _ 
                                       & "AcquisitionDateTime: {5}" _ 
                                       & Constants.vbLf _ 
                                       & "BurnedInAnnotation: {6}" _ 
                                       & Constants.vbLf _ 
                                       & "DocumentTitle: {7}" _ 
                                       & Constants.vbLf _ 
                                       & "VerificationFlag: {8}" _ 
                                       & Constants.vbLf _ 
                                       & "HL7InstanceIdentifier: {9}" _ 
                                       & Constants.vbLf _ 
                                       & "MIMETypeOfEncapsulatedDocument: {10}" _ 
                                       & Constants.vbLf _ 
                                       & "ListOfMIMETypes: {11}" _ 
                                       & Constants.vbLf + Constants.vbLf, 
                                       sMsgIn, encapsulatedDocument.Type.ToString(), 
                                       encapsulatedDocument.InstanceNumber, 
                                       encapsulatedDocument.ContentDate.ToString(), 
                                       encapsulatedDocument.ContentTime.ToString(), 
                                       encapsulatedDocument.AcquisitionDateTime.ToString(), 
                                       encapsulatedDocument.BurnedInAnnotation, 
                                       encapsulatedDocument.DocumentTitle, 
                                       encapsulatedDocument.VerificationFlag, 
                                       encapsulatedDocument.HL7InstanceIdentifier, 
                                       encapsulatedDocument.MimeTypeOfEncapsulatedDocument, 
                                       sMimeTypes) 
 
   ' ConceptNameCodeSequence 
   Dim sMsg2 As String = String.Format("CodeValue: {0}" _ 
                                       & Constants.vbLf _ 
                                       & "CodingSchemeDesignator: {1}" _ 
                                       & Constants.vbLf _ 
                                       & "CodingSchemeVersion: {2}" _ 
                                       & Constants.vbLf _ 
                                       & "CodeMeaning: {3}" _ 
                                       & Constants.vbLf _ 
                                       & "ContextIdentifier: {4}" _ 
                                       & Constants.vbLf _ 
                                       & "MappingResource: {5}" _ 
                                       & Constants.vbLf _ 
                                       & "ContextGroupVersion: {6}" _ 
                                       & Constants.vbLf _ 
                                       & "ContextGroupLocalVersion: {7}" _ 
                                       & Constants.vbLf _ 
                                       & "ContextGroupExtensionCreatorUID: {8}", 
                                       conceptNameCodeSequence.CodeValue, 
                                       conceptNameCodeSequence.CodingSchemeDesignator, 
                                       conceptNameCodeSequence.CodingSchemeVersion, 
                                       conceptNameCodeSequence.CodeMeaning, 
                                       conceptNameCodeSequence.ContextIdentifier, 
                                       conceptNameCodeSequence.MappingResource, 
                                       conceptNameCodeSequence.ContextGroupVersion.ToString(), 
                                       conceptNameCodeSequence.ContextGroupLocalVersion.ToString(), 
                                       conceptNameCodeSequence.ContextGroupExtensionCreatorUID) 
 
   Debug.WriteLine(sMsg1 & sMsg2) 
End Sub

Requirements

Target Platforms

See Also

Reference

DicomDataSet Class

DicomDataSet Members

Overload List

[GetEncapsulatedDocument(DicomElement,Boolean,String,DicomEncapsulatedDocument,DicomCodeSequenceItem)Method

SetEncapsulatedDocument(DicomElement,Boolean,String,DicomEncapsulatedDocument,DicomCodeSequenceItem) Method

DicomEncapsulatedDocument Class

Help Version 20.0.2020.3.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Dicom Assembly
Introduction
Getting Started
Namespaces
Leadtools.Dicom Namespace
Assemblies