#include "l_bitmap.h"

L_LTDIC_API L_UINT16 EXT_FUNCTION L_DicomSetEncapsulatedDocument(hDS, pElement, bChild, pszFileDocument, pEncapsulatedDocument, pConceptNameCodeSequence)

Inserts an encapsulated document and corresponding DICOM elements into a DICOM data set.  This feature is available in version 16 or higher.



A DICOM handle.


Pointer to a DICOMELEMENT structure that contains an item in the Data Set. The inserted item will be inserted as a neighbor to this item, or as a child, depending on the value of bChild.

L_BOOL bChild

Flag that indicates where to insert the item. Possible values are:

Value Meaning
TRUE The new item will be inserted as the last child of pElement.
FALSE The new item will be inserted as the last sibling of pElement.

L_TCHAR * pszFileDocument

Character string that contains the name of the file that will be encapsulated. This should either be a PDF or a CDA file.


Pointer to a DICOMENCAPSULATEDDOCUMENT structure, which is filled with the encapsulated document module attributes. This member must NOT be NULL.


Pointer to a DICOMCODESEQUENCEITEM structure, which is filled with the Concept Name Code Sequence attributes. This member can be NULL.


Value Meaning
DICOM_SUCCESS The function was successful.
> 0 An error occurred. Refer to Return Codes.


The members of the DICOMENCAPSULATEDDOCUMENT structure and the DICOMCODESEQUENCEITEM structure together represent the set of attributes contained in the "Encapsulated Document Module Attributes". The Encapsulated Information Object Definition (IOD) describes either a

that has been encapsulated within a DICOM information object.

For more information, refer to Part 3 of the DICOM standard.

The DICOMENCAPSULATEDDOCUMENT structure corresponds to the Encapsulated Document Module Attributes described in part 3 of the DICOM specification. To include the Concept Name Code Sequence element (0040,A043) pass a pointer to a pConceptNameCodeSequence item.

The pszFileDocument argument points to a file that contains the document that you want to encapsulate. This should be either a PDF or a CDA document, and the uType member of the DICOMENCAPSULATEDDOCUMENT structure should be set accordingly.

Before calling this function:

  1. Initialize pEncapsulatedDocument ->uStructSize to be sizeof(DICOMENCAPSULATEDDOCUMENT) and initialize the structure members. Any of the members of the structure that are pointers can be NULL. NULL members will be ignored and the corresponding elements will not be inserted into the DICOM data set

  2. If pConceptNameCodeSequence is not NULL, initialize pConceptNameCodeSequence ->uStructSize to be sizeof(DICOMCODESEQUENCEITEM) and initialize all structure members. Any of the members of the structure that are pointers can be NULL. NULL members will be ignored and the corresponding elements will not be inserted into the DICOM data set

Required DLLs and Libraries


Win32, x64, Linux.

See Also




This example adds an encapsulated document, along with several encapsulated document tags to an existing DICOM data set.

L_INT DicomSetEncapsulatedDocumentExample(pDICOMELEMENT pElement, L_BOOL bChild, HDICOMDS hDS, L_TCHAR *pszFileDocumentIn) 
   DICOMENCAPSULATEDDOCUMENT EncapsulatedDocument = {0}; 
   EncapsulatedDocument.uStructSize = sizeof(DICOMENCAPSULATEDDOCUMENT); 
   EncapsulatedDocument.uType = ENCAPSULATED_DOCUMENT_PDF; 
   EncapsulatedDocument.nInstanceNumber = 123; 
   VALUEDATE contentDate = {2008, 12, 31}; 
   EncapsulatedDocument.pContentDate = &contentDate; 
   VALUETIME contentTime = {12, 30, 00, 1}; 
   EncapsulatedDocument.pContentTime = &contentTime; 
   VALUEDATETIME acquisitionDateTime = {2008, 12, 31, 12, 30, 00, 01, -3}; 
   EncapsulatedDocument.pAcquisitionDateTime = &acquisitionDateTime; 
   EncapsulatedDocument.pszBurnedInAnnotation               = TEXT("YES"); 
   EncapsulatedDocument.pszDocumentTitle                    = pszFileDocumentIn; 
   EncapsulatedDocument.pszVerificationFlag                 = TEXT("UNVERIFIED"); 
   EncapsulatedDocument.pszHL7InstanceIdentifier            = NULL; 
   // The 'pszMIMETypeOfEncapsulatedDocument' field is ignored when calling SetEncapsulatedDocument 
   // It is filled in when calling 'SetEncapsulatedDocument' 
   EncapsulatedDocument.pszMIMETypeOfEncapsulatedDocument   = TEXT("***** This is ignored when calling SetEncapsulatedDocument *****"); 
   EncapsulatedDocument.pszListOfMIMETypes                  = TEXT("image/jpeg\0application/pdf"); 
   EncapsulatedDocument.nListOfMIMETypesCount               = 2; 
   DICOMCODESEQUENCEITEM ConceptNameCodeSequence = {0}; 
   ConceptNameCodeSequence.uStructSize                      = sizeof(DICOMCODESEQUENCEITEM); 
   ConceptNameCodeSequence.pszCodingSchemeDesignator        = TEXT("LN"); 
   ConceptNameCodeSequence.pszCodeValue                     = TEXT("12345"); 
   ConceptNameCodeSequence.pszCodeMeaning                   = TEXT("Sample Code Meaning"); 
   L_UINT16 uRet = L_DicomSetEncapsulatedDocument(hDS, pElement, bChild, pszFileDocumentIn, &EncapsulatedDocument, &ConceptNameCodeSequence); 
   return uRet; 

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