DICOMENCAPSULATEDDOCUMENT

Show in webframe

typedef struct _DICOMENCAPSULATEDDOCUMENT
   {
      L_UINT  uStructSize; // Structure Size
      L_UINT16 uType;        // ENCAPSULATED_DOCUMENT_PDF or ENCAPSULATED_DOCUMENT_CDA
      L_INT32 nInstanceNumber;                      // (0020, 0013)    Type1    VR_IS    1  IntegerString
      pVALUEDATE pContentDate;                          // (0008, 0023)    Type2    VR_DA    1  Date
      pVALUETIME pContentTime;                          // (0008, 0033)    Type2    VR_TM    1  Time
      pVALUEDATETIME  pAcquisitionDateTime;                  // (0008, 002A)    Type2    VR_DT    1  DateTime
      L_TCHAR *pszBurnedInAnnotation;                 // (0028, 0301)    Type1    VR_CS    1 CodeString   "YES" or "NO"
      L_TCHAR *pszDocumentTitle;                      // (0042, 0010)    Type2    VR_ST    1 ShortText
      L_TCHAR *pszVerificationFlag;                   // (0040, A493)    Type3  VR_CS    1 CodeStrin "UNVERIFIED" or "VERIFIED"
      L_TCHAR *pszHL7InstanceIdentifier;              // (0040, E001)    Type1C   VR_ST   1 ShortText
      L_TCHAR *pszMIMETypeOfEncapsulatedDocument;     // (0042, 0012)    Type1    VR_LO   1 LongString
      L_TCHAR *pszListOfMIMETypes;                    // (0042, 0014)    Type1C   VR_LO   1.FFFFF  LongString
      L_UINT32 nListOfMIMETypesCount;                 // Number of NULL terminated strings in 'pszListOfMIMETypes'
   } DICOMENCAPSULATEDDOCUMENT,   *pDICOMENCAPSULATEDDOCUMENT;

The DICOMENCAPSULATEDDOCUMENT structure represents the set of attributes contained in the "Encapsulated Document Module Attributes".

Member	Description
uStructSize	The size of the structure (use sizeof(DICOMENCAPSULATEDDOCUMENT) )
uType	Encapsulated document format. Possible values are:
	Constants	Meaning
	ENCAPSULATED_DOCUMENT_UNKNOWN= 0	Encapsulated document format is unknown.
	ENCAPSULATED_DOCUMENT_PDF= 1	Encapsulated document format is PDF (Adobe Portable Document Format)
	ENCAPSULATED_DOCUMENT_CDA = 2	Encapsulated document format is CDA (Clinical Document Architecture)
nInstanceNumber	Pointer to a character string that contains the "Instance Number (0020,0013) element. Can be NULL.
pContentDate	Pointer to a VALUEDATE structure that contains the "Content Date" (0008:0023) element. Can be NULL.
pContentTime	Pointer to a VALUETIME structure that contains the "Content Time" (0008,0033) element. Can be NULL.
pAcquisitionDateTime	Pointer to a VALUEDATETIME structure that contains the "Acquisition DateTime" (0008:002A) element. Can be NULL.
pszBurnedInAnnotation	Pointer to a character string that contains the "Burned In Annotation" (0028:0301) element. Possible values are: "YES" "NO" Can be NULL.
pszDocumentTitle	Pointer to a character string that contains the "Burned In Annotation" (0028:0301) element. Can be NULL.
pszVerificationFlag	Pointer to a character string that contains the "Verification Flag" (0040:A493) element. Can be NULL.
pszHL7InstanceIdentifier	Pointer to a character string that contains the "HL7 Instance Identifier" (0040:E001) element. Can be NULL.
pszMIMETypeOfEncapsulatedDocument	Pointer to a character string that contains the "MIME Type of Encapsulated Document" (0042:0012) element. Can be NULL.
pszListOfMIMETypes	Pointer to a character string that contains the "List of MIME Types" (0042:0014) element. Can be NULL.
nListOfMIMETypesCount	Unsigned integer contains the total number of null terminated strings that the pszListOfMIMETypes points to.

Comments

The members of this structure 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 pszMIMETypeOfEncapsulatedDocument field is ignored when calling the L_DicomSetEncapsulatedDocument function. The contents of the uType member determine the contents of the "MIME Type of Encapsulated Document" (0042:0012) element.

The pszListOfMIMETypes points to a string buffer that can contain zero or more null-terminated strings. The nListOfMIMETypesCount member contains the count of null-terminated strings. For example, the illustration below shows a character string, containing three strings separated by the 0 delimiter.

Any of the members of the structure that are pointers can be NULL. When calling the L_DicomSetEncapsulatedDocument function, NULL members will be ignored and the corresponding elements will not be inserted into the DICOM data set. When calling the L_DicomGetEncapsulatedDocument function, a member with a NULL value means that the corresponding DICOM element was not present in the DICOM data set.