Package org.projecthusky.common.communication

Enum Class DocumentMetadata.DocumentMetadataExtractionMode

java.lang.Object
java.lang.Enum<DocumentMetadata.DocumentMetadataExtractionMode>
org.projecthusky.common.communication.DocumentMetadata.DocumentMetadataExtractionMode
All Implemented Interfaces:
Serializable, Comparable<DocumentMetadata.DocumentMetadataExtractionMode>, Constable
Enclosing class:
DocumentMetadata
public static enum DocumentMetadata.DocumentMetadataExtractionMode extends Enum<DocumentMetadata.DocumentMetadataExtractionMode>
The Class MetadataExtractionMode

  • Enum Constant Details

    • DEFAULT_EXTRACTION

      public static final DocumentMetadata.DocumentMetadataExtractionMode DEFAULT_EXTRACTION
      Minimal (secure) metadata will be extracted if set to default, metadata for the document entries will be extracted as far as this is possible. if set to false the user of this API has to set all data by himself. Extraction from CDA Documents to Document Entries uses the following mapping (for more details see CDAR2Extractor.pdf in org.openhealthtools.ihe.xds.metadata.extract.cdar2):
      CDA Metadata to XDS Metadata mapping
      XDS Metadata Attribute XDS Element
      creationTime ClinicalDocument/effectiveTime
      languageCode ClinicalDocument/languageCode/@code
      legalAuthenticator ClinicalDocument/legalAuthenticator/assignedEntity/id and ClinicalDocument /legalAuthenticator/assignedEntity/assignedPerson/name
      serviceStartTime ClinicalDocument/documentationOf/serviceEvent/effectiveTime This time is to be in UTC, but without the timezone offset or fractional seconds: [[[[[YYYY]MM]DD]HH]mm]ss].
      serviceStopTime ClinicalDocument/documentationOf/serviceEvent/effectiveTime This time is to be in UTC, but without the timezone offset or fractional seconds: [[[[[YYYY]MM]DD]HH]mm]ss]
      sourcePatientId ClinicalDocument/recordTarget/patientRole/id
      sourcePatientInfo ClinicalDocument/recordTarget/patientRole
      title ClinicalDocument/title
      uniqueId ClinicalDocument/id@extension and ClinicalDocument/id@root

      The following attributes will be generated as described, if they are not present in the document entries:
      Empty document entries attributes generation
      XDS Metadata Attribute Generated from
      mimeType the DocumentDescriptor, which has been provided by adding the document
      creationTime current time
      uniqueId the docSourceActorOrgId attribute from the DocumentMetadata

    • NO_METADATA_EXTRACTION

      public static final DocumentMetadata.DocumentMetadataExtractionMode NO_METADATA_EXTRACTION
      No metadata will be extracted, automatically

  • Method Details

    • values

      public static DocumentMetadata.DocumentMetadataExtractionMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DocumentMetadata.DocumentMetadataExtractionMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null