Package org.projecthusky.common.communication

Class SubmissionSetMetadata

java.lang.Object
org.projecthusky.common.communication.SubmissionSetMetadata
Direct Known Subclasses:
SubmissionSetMetadataAt
public class SubmissionSetMetadata extends Object
Represents the metadata for a submission set (which can hold one or more documents)

  • Constructor Details

    • SubmissionSetMetadata

      public SubmissionSetMetadata()
      Standard Constructor.

    • SubmissionSetMetadata

      public SubmissionSetMetadata(org.openehealth.ipf.commons.ihe.xds.core.metadata.SubmissionSet submissionSet)
      Constructor with IPF SubmissionSet object.
      Parameters:
      submissionSet - the IPF submission set object

  • Method Details

    • getAuthor

      public List<Author> getAuthor()
      Gets the Author of this Submission
      Returns:
      the Author as Convenience API Object

    • getAuthorTypeMdht

      public List<org.openehealth.ipf.commons.ihe.xds.core.metadata.Author> getAuthorTypeMdht()
      Gets the mdht author type .
      Returns:
      the mdht author type.

    • getAvailabilityStatus

      public org.openehealth.ipf.commons.ihe.xds.core.metadata.AvailabilityStatus getAvailabilityStatus()
      Gets the Availability Status of the Document
      Returns:
      status the AvailabilityStatus

    • getComments

      public String getComments()
      Gets comments for this submission
      Returns:
      comments the comments

    • getContentTypeCode

      public Code getContentTypeCode()
      Gets the contentTypeCode, which defines the type of the submission set content
      Returns:
      code the contentTypeCode

    • getEntryUUID

      public String getEntryUUID()
      Gets the EntryUUID
      Returns:
      the EntryUUID

    • getIpfSubmissionSet

      public org.openehealth.ipf.commons.ihe.xds.core.metadata.SubmissionSet getIpfSubmissionSet()
      Gets the IPF SubmissionSet Object, which is wrapped by this class.
      Returns:
      the IPF SubmissionSet Object

    • getPatientId

      public Identificator getPatientId()
      Gets the ID of the patient
      Returns:
      id the patientId

    • getSourceId

      public String getSourceId()
      Gets the ID of the sending facility (e.g. a hospital id)
      Returns:
      id the SourceId

    • getTitle

      public String getTitle()
      Gets the title of the submission set
      Returns:
      the title

    • getUniqueId

      public String getUniqueId()
      Gets the uniqueid of the submission set
      Returns:
      hte unique id

    • setAuthor

      @Deprecated public void setAuthor(Author author)
      Deprecated.
      Sets the Author of this submission. This method is deprecated, since the author role is not encoded as II serialization and only sets the name of the role. E.g. "Heathcare professional" instead of "HCP^^^&2.16.756.5.30.1.127.3.10.6&ISO", which is required for the Swiss EPR.
      Parameters:
      author - the Author

    • addAuthor

      public void addAuthor(Author author)
      add an author object to the SubmissionSetMetadata object. In constrast to the method above, it uses the same metadata extractor used in the DocumentMetadata
      Parameters:
      author -

    • setAvailabilityStatus

      public void setAvailabilityStatus(org.openehealth.ipf.commons.ihe.xds.core.metadata.AvailabilityStatus status)
      Sets the Availability Status of the Document
      Parameters:
      status - the AvailabilityStatus

    • setComments

      public void setComments(String comments)
      Sets comments for this submission
      Parameters:
      comments - the comments

    • setContentTypeCode

      public void setContentTypeCode(Code code)
      Sets the contentTypeCode, which defines the type of the submission set content
      Parameters:
      code - the contentTypeCode

    • setDestinationPatientId

      public void setDestinationPatientId(Identificator id)
      Sets the ID for the patient in the destination
      Parameters:
      id - the patientId

    • setEntryUUID

      public void setEntryUUID(String entryUuid)
      Sets the entry uuid.
      Parameters:
      entryUuid - the uuid to be set

    • setSourceId

      public void setSourceId(String id)
      Sets the ID of the sending facility (e.g. a hospital id)
      Parameters:
      id - the SourceId

    • setTitle

      public void setTitle(String title)
      Sets the title of the submission set
      Parameters:
      title - the title

    • setUniqueId

      public void setUniqueId(String uniqueyId)
      Sets the unique id.
      Parameters:
      uniqueyId - the unique id to be set

    • toOhtSubmissionSetType

      public org.openehealth.ipf.commons.ihe.xds.core.metadata.SubmissionSet toOhtSubmissionSetType(org.openehealth.ipf.commons.ihe.xds.core.metadata.SubmissionSet ohtSubmissionSetType)
      Fills a given IPF SubmissionSetType object with the data of this submission set class
      Parameters:
      ohtSubmissionSetType - the SubmissionSetType
      Returns:
      the filled ohtSubmissionSetType