Package org.dcm4che.typeddicom.valuerepresentations

Interface PersonNameWrapper

  • All Superinterfaces:
    org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper
    All Known Implementing Classes:
    ContentCreatorName, CurrentObserverTrial, DistributionName, DocumentAuthorTrial, EvaluatorName, HumanPerformerName, InterpretationAuthor, InterpretationRecorder, InterpretationTranscriber, OrderEnteredBy, PatientBirthName, PatientMotherBirthName, PatientName, PersonName, PhysicianApprovingInterpretation, ReferringPhysicianName, RequestingPhysician, ResponsiblePerson, ReviewerName, ROIInterpreter, ScheduledPerformingPhysicianName, SecondaryReviewerName, VerbalSourceTrial, VerifyingObserverName
    public interface PersonNameWrapper
extends org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper
    Name: Person Name
    Tag: PN
    Definition:

    A character string encoded using a 5 component convention. The character code 5CH (the BACKSLASH "\" in ISO-IR 6) shall not be present, as it is used as the delimiter between Values in multi-valued Data Elements. The string may be padded with trailing spaces. For human use, the five components in their order of occurrence are: family name complex, given name complex, middle name, name prefix, name suffix.

    Note

    HL7 prohibits leading spaces within a component; DICOM allows leading and trailing spaces and considers them insignificant.

    Any of the five components may be an empty string. The component delimiter shall be the caret "^" character (5EH). There shall be no more than four component delimiters, i.e., none after the last component if all components are present. Delimiters are required for interior null components. Trailing null components and their delimiters may be omitted. Multiple entries are permitted in each component and are encoded as natural text strings, in the format preferred by the named person.

    For veterinary use, the first two of the five components in their order of occurrence are: responsible party family name or responsible organization name, patient name. The remaining components are not used and shall not be present.

    This group of five components is referred to as a Person Name component group.

    For the purpose of writing names in ideographic characters and in phonetic characters, up to 3 groups of components (see DICOM Standard Part 5 - chapter_H, DICOM Standard Part 5 - chapter_I and DICOM Standard Part 5 - chapter_J) may be used. The delimiter for component groups shall be the equals character "=" (3DH). There shall be no more than two component group delimiters, i.e., none after the last component group if all component groups are present. The three component groups of components in their order of occurrence are: an alphabetic representation, an ideographic representation, and a phonetic representation.

    Any component group may be absent, including the first component group. In this case, the person name may start with one or more "=" delimiters. Delimiters are required for interior null component groups. Trailing null component groups and their delimiters may be omitted.

    Precise semantics are defined for each component group. See DICOM Standard Part 5 - Section 6.2.1.2.

    For examples and notes, see DICOM Standard Part 5 - Section 6.2.1.1.


    Character Repertoire:

    Default Character Repertoire and/or as defined by (0008,0005) excluding character code 5CH (the BACKSLASH "\" in ISO-IR 6) and all Control Characters except ESC when used for DICOM Standard Part 5 - biblio_ISOIEC2022 escape sequences.


    Length of Value:

    64 chars maximum per component group

    (see DICOM Standard Part 5 - note_6.1-2-1)


    See Also:
    DICOM Standard Part 5 - Person Name

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  PersonNameWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,​? extends org.dcm4che.typeddicom.AttributesWrapper>,​D extends PersonNameWrapper>  

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default org.dcm4che3.data.VR getValueRepresentation()  

      • Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

        copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

      • Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

        getBytes, getSafeBytes, setBytes

      • Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

        exists, getPrivateCreator, getTag, getValue

      • Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

        getString, setString

    • Method Detail

      • getValueRepresentation

        default org.dcm4che3.data.VR getValueRepresentation()
        Specified by:
        getValueRepresentation in interface org.dcm4che.typeddicom.DataElementWrapper