Package ca.uhn.hl7v2.model.v251.segment

Class CER

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v251.segment.CER
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class CER extends AbstractSegment

Represents an HL7 CER message segment (Certificate Detail). This segment has the following fields:

  • CER-1: Set ID - CER (SI)
  • CER-2: Serial Number (ST) optional
  • CER-3: Version (ST) optional
  • CER-4: Granting Authority (XON) optional
  • CER-5: Issuing Authority (XCN) optional
  • CER-6: Signature of Issuing Authority (ED) optional
  • CER-7: Granting Country (ID) optional
  • CER-8: Granting State/Province (CWE) optional
  • CER-9: Granting County/Parish (CWE) optional
  • CER-10: Certificate Type (CWE) optional
  • CER-11: Certificate Domain (CWE) optional
  • CER-12: Subject ID (ID) optional
  • CER-13: Subject Name (ST)
  • CER-14: Subject Directory Attribute Extension (Health Professional Data) (CWE) optional repeating
  • CER-15: Subject Public Key Info (CWE) optional
  • CER-16: Authority Key Identifier (CWE) optional
  • CER-17: Basic Constraint (ID) optional
  • CER-18: CRL Distribution Point (CWE) optional repeating
  • CER-19: Jurisdiction Country (ID) optional
  • CER-20: Jurisdiction State/Province (CWE) optional
  • CER-21: Jurisdiction County/Parish (CWE) optional
  • CER-22: Jurisdiction Breadth (CWE) optional repeating
  • CER-23: Granting Date (TS) optional
  • CER-24: Issuing Date (TS) optional
  • CER-25: Activation Date (TS) optional
  • CER-26: Inactivation Date (TS) optional
  • CER-27: Expiration Date (TS) optional
  • CER-28: Renewal Date (TS) optional
  • CER-29: Revocation Date (TS) optional
  • CER-30: Revocation Reason Code (CE) optional
  • CER-31: Certificate Status (CWE) optional
See Also:

  • Constructor Details

  • Method Details

    • getSetIDCER

      public SI getSetIDCER()
      Returns CER-1: "Set ID - CER" - creates it if necessary

    • getCer1_SetIDCER

      public SI getCer1_SetIDCER()
      Returns CER-1: "Set ID - CER" - creates it if necessary

    • getSerialNumber

      public ST getSerialNumber()
      Returns CER-2: "Serial Number" - creates it if necessary

    • getCer2_SerialNumber

      public ST getCer2_SerialNumber()
      Returns CER-2: "Serial Number" - creates it if necessary

    • getVersion

      public ST getVersion()
      Returns CER-3: "Version" - creates it if necessary

    • getCer3_Version

      public ST getCer3_Version()
      Returns CER-3: "Version" - creates it if necessary

    • getGrantingAuthority

      public XON getGrantingAuthority()
      Returns CER-4: "Granting Authority" - creates it if necessary

    • getCer4_GrantingAuthority

      public XON getCer4_GrantingAuthority()
      Returns CER-4: "Granting Authority" - creates it if necessary

    • getIssuingAuthority

      public XCN getIssuingAuthority()
      Returns CER-5: "Issuing Authority" - creates it if necessary

    • getCer5_IssuingAuthority

      public XCN getCer5_IssuingAuthority()
      Returns CER-5: "Issuing Authority" - creates it if necessary

    • getSignatureOfIssuingAuthority

      public ED getSignatureOfIssuingAuthority()
      Returns CER-6: "Signature of Issuing Authority" - creates it if necessary

    • getCer6_SignatureOfIssuingAuthority

      public ED getCer6_SignatureOfIssuingAuthority()
      Returns CER-6: "Signature of Issuing Authority" - creates it if necessary

    • getGrantingCountry

      public ID getGrantingCountry()
      Returns CER-7: "Granting Country" - creates it if necessary

    • getCer7_GrantingCountry

      public ID getCer7_GrantingCountry()
      Returns CER-7: "Granting Country" - creates it if necessary

    • getGrantingStateProvince

      public CWE getGrantingStateProvince()
      Returns CER-8: "Granting State/Province" - creates it if necessary

    • getCer8_GrantingStateProvince

      public CWE getCer8_GrantingStateProvince()
      Returns CER-8: "Granting State/Province" - creates it if necessary

    • getGrantingCountyParish

      public CWE getGrantingCountyParish()
      Returns CER-9: "Granting County/Parish" - creates it if necessary

    • getCer9_GrantingCountyParish

      public CWE getCer9_GrantingCountyParish()
      Returns CER-9: "Granting County/Parish" - creates it if necessary

    • getCertificateType

      public CWE getCertificateType()
      Returns CER-10: "Certificate Type" - creates it if necessary

    • getCer10_CertificateType

      public CWE getCer10_CertificateType()
      Returns CER-10: "Certificate Type" - creates it if necessary

    • getCertificateDomain

      public CWE getCertificateDomain()
      Returns CER-11: "Certificate Domain" - creates it if necessary

    • getCer11_CertificateDomain

      public CWE getCer11_CertificateDomain()
      Returns CER-11: "Certificate Domain" - creates it if necessary

    • getSubjectID

      public ID getSubjectID()
      Returns CER-12: "Subject ID" - creates it if necessary

    • getCer12_SubjectID

      public ID getCer12_SubjectID()
      Returns CER-12: "Subject ID" - creates it if necessary

    • getSubjectName

      public ST getSubjectName()
      Returns CER-13: "Subject Name" - creates it if necessary

    • getCer13_SubjectName

      public ST getCer13_SubjectName()
      Returns CER-13: "Subject Name" - creates it if necessary

    • getSubjectDirectoryAttributeExtensionHealthProfessionalData

      public CWE[] getSubjectDirectoryAttributeExtensionHealthProfessionalData()
      Returns all repetitions of Subject Directory Attribute Extension (Health Professional Data) (CER-14).

    • getCer14_SubjectDirectoryAttributeExtensionHealthProfessionalData

      public CWE[] getCer14_SubjectDirectoryAttributeExtensionHealthProfessionalData()
      Returns all repetitions of Subject Directory Attribute Extension (Health Professional Data) (CER-14).

    • getSubjectDirectoryAttributeExtensionHealthProfessionalDataReps

      public int getSubjectDirectoryAttributeExtensionHealthProfessionalDataReps()
      Returns a count of the current number of repetitions of Subject Directory Attribute Extension (Health Professional Data) (CER-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSubjectDirectoryAttributeExtensionHealthProfessionalData

      public CWE getSubjectDirectoryAttributeExtensionHealthProfessionalData(int rep)
      Returns a specific repetition of CER-14: "Subject Directory Attribute Extension (Health Professional Data)" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCer14_SubjectDirectoryAttributeExtensionHealthProfessionalData

      public CWE getCer14_SubjectDirectoryAttributeExtensionHealthProfessionalData(int rep)
      Returns a specific repetition of CER-14: "Subject Directory Attribute Extension (Health Professional Data)" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCer14_SubjectDirectoryAttributeExtensionHealthProfessionalDataReps

      public int getCer14_SubjectDirectoryAttributeExtensionHealthProfessionalDataReps()
      Returns a count of the current number of repetitions of Subject Directory Attribute Extension (Health Professional Data) (CER-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSubjectDirectoryAttributeExtensionHealthProfessionalData

      public CWE insertSubjectDirectoryAttributeExtensionHealthProfessionalData(int rep) throws HL7Exception
      Inserts a repetition of CER-14: "Subject Directory Attribute Extension (Health Professional Data)" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertCer14_SubjectDirectoryAttributeExtensionHealthProfessionalData

      public CWE insertCer14_SubjectDirectoryAttributeExtensionHealthProfessionalData(int rep) throws HL7Exception
      Inserts a repetition of CER-14: "Subject Directory Attribute Extension (Health Professional Data)" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeSubjectDirectoryAttributeExtensionHealthProfessionalData

      public CWE removeSubjectDirectoryAttributeExtensionHealthProfessionalData(int rep) throws HL7Exception
      Removes a repetition of CER-14: "Subject Directory Attribute Extension (Health Professional Data)" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeCer14_SubjectDirectoryAttributeExtensionHealthProfessionalData

      public CWE removeCer14_SubjectDirectoryAttributeExtensionHealthProfessionalData(int rep) throws HL7Exception
      Removes a repetition of CER-14: "Subject Directory Attribute Extension (Health Professional Data)" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • getSubjectPublicKeyInfo

      public CWE getSubjectPublicKeyInfo()
      Returns CER-15: "Subject Public Key Info" - creates it if necessary

    • getCer15_SubjectPublicKeyInfo

      public CWE getCer15_SubjectPublicKeyInfo()
      Returns CER-15: "Subject Public Key Info" - creates it if necessary

    • getAuthorityKeyIdentifier

      public CWE getAuthorityKeyIdentifier()
      Returns CER-16: "Authority Key Identifier" - creates it if necessary

    • getCer16_AuthorityKeyIdentifier

      public CWE getCer16_AuthorityKeyIdentifier()
      Returns CER-16: "Authority Key Identifier" - creates it if necessary

    • getBasicConstraint

      public ID getBasicConstraint()
      Returns CER-17: "Basic Constraint" - creates it if necessary

    • getCer17_BasicConstraint

      public ID getCer17_BasicConstraint()
      Returns CER-17: "Basic Constraint" - creates it if necessary

    • getCRLDistributionPoint

      public CWE[] getCRLDistributionPoint()
      Returns all repetitions of CRL Distribution Point (CER-18).

    • getCer18_CRLDistributionPoint

      public CWE[] getCer18_CRLDistributionPoint()
      Returns all repetitions of CRL Distribution Point (CER-18).

    • getCRLDistributionPointReps

      public int getCRLDistributionPointReps()
      Returns a count of the current number of repetitions of CRL Distribution Point (CER-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getCRLDistributionPoint

      public CWE getCRLDistributionPoint(int rep)
      Returns a specific repetition of CER-18: "CRL Distribution Point" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCer18_CRLDistributionPoint

      public CWE getCer18_CRLDistributionPoint(int rep)
      Returns a specific repetition of CER-18: "CRL Distribution Point" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCer18_CRLDistributionPointReps

      public int getCer18_CRLDistributionPointReps()
      Returns a count of the current number of repetitions of CRL Distribution Point (CER-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertCRLDistributionPoint

      public CWE insertCRLDistributionPoint(int rep) throws HL7Exception
      Inserts a repetition of CER-18: "CRL Distribution Point" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertCer18_CRLDistributionPoint

      public CWE insertCer18_CRLDistributionPoint(int rep) throws HL7Exception
      Inserts a repetition of CER-18: "CRL Distribution Point" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeCRLDistributionPoint

      public CWE removeCRLDistributionPoint(int rep) throws HL7Exception
      Removes a repetition of CER-18: "CRL Distribution Point" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeCer18_CRLDistributionPoint

      public CWE removeCer18_CRLDistributionPoint(int rep) throws HL7Exception
      Removes a repetition of CER-18: "CRL Distribution Point" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • getJurisdictionCountry

      public ID getJurisdictionCountry()
      Returns CER-19: "Jurisdiction Country" - creates it if necessary

    • getCer19_JurisdictionCountry

      public ID getCer19_JurisdictionCountry()
      Returns CER-19: "Jurisdiction Country" - creates it if necessary

    • getJurisdictionStateProvince

      public CWE getJurisdictionStateProvince()
      Returns CER-20: "Jurisdiction State/Province" - creates it if necessary

    • getCer20_JurisdictionStateProvince

      public CWE getCer20_JurisdictionStateProvince()
      Returns CER-20: "Jurisdiction State/Province" - creates it if necessary

    • getJurisdictionCountyParish

      public CWE getJurisdictionCountyParish()
      Returns CER-21: "Jurisdiction County/Parish" - creates it if necessary

    • getCer21_JurisdictionCountyParish

      public CWE getCer21_JurisdictionCountyParish()
      Returns CER-21: "Jurisdiction County/Parish" - creates it if necessary

    • getJurisdictionBreadth

      public CWE[] getJurisdictionBreadth()
      Returns all repetitions of Jurisdiction Breadth (CER-22).

    • getCer22_JurisdictionBreadth

      public CWE[] getCer22_JurisdictionBreadth()
      Returns all repetitions of Jurisdiction Breadth (CER-22).

    • getJurisdictionBreadthReps

      public int getJurisdictionBreadthReps()
      Returns a count of the current number of repetitions of Jurisdiction Breadth (CER-22). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getJurisdictionBreadth

      public CWE getJurisdictionBreadth(int rep)
      Returns a specific repetition of CER-22: "Jurisdiction Breadth" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCer22_JurisdictionBreadth

      public CWE getCer22_JurisdictionBreadth(int rep)
      Returns a specific repetition of CER-22: "Jurisdiction Breadth" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCer22_JurisdictionBreadthReps

      public int getCer22_JurisdictionBreadthReps()
      Returns a count of the current number of repetitions of Jurisdiction Breadth (CER-22). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertJurisdictionBreadth

      public CWE insertJurisdictionBreadth(int rep) throws HL7Exception
      Inserts a repetition of CER-22: "Jurisdiction Breadth" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertCer22_JurisdictionBreadth

      public CWE insertCer22_JurisdictionBreadth(int rep) throws HL7Exception
      Inserts a repetition of CER-22: "Jurisdiction Breadth" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeJurisdictionBreadth

      public CWE removeJurisdictionBreadth(int rep) throws HL7Exception
      Removes a repetition of CER-22: "Jurisdiction Breadth" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeCer22_JurisdictionBreadth

      public CWE removeCer22_JurisdictionBreadth(int rep) throws HL7Exception
      Removes a repetition of CER-22: "Jurisdiction Breadth" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • getGrantingDate

      public TS getGrantingDate()
      Returns CER-23: "Granting Date" - creates it if necessary

    • getCer23_GrantingDate

      public TS getCer23_GrantingDate()
      Returns CER-23: "Granting Date" - creates it if necessary

    • getIssuingDate

      public TS getIssuingDate()
      Returns CER-24: "Issuing Date" - creates it if necessary

    • getCer24_IssuingDate

      public TS getCer24_IssuingDate()
      Returns CER-24: "Issuing Date" - creates it if necessary

    • getActivationDate

      public TS getActivationDate()
      Returns CER-25: "Activation Date" - creates it if necessary

    • getCer25_ActivationDate

      public TS getCer25_ActivationDate()
      Returns CER-25: "Activation Date" - creates it if necessary

    • getInactivationDate

      public TS getInactivationDate()
      Returns CER-26: "Inactivation Date" - creates it if necessary

    • getCer26_InactivationDate

      public TS getCer26_InactivationDate()
      Returns CER-26: "Inactivation Date" - creates it if necessary

    • getExpirationDate

      public TS getExpirationDate()
      Returns CER-27: "Expiration Date" - creates it if necessary

    • getCer27_ExpirationDate

      public TS getCer27_ExpirationDate()
      Returns CER-27: "Expiration Date" - creates it if necessary

    • getRenewalDate

      public TS getRenewalDate()
      Returns CER-28: "Renewal Date" - creates it if necessary

    • getCer28_RenewalDate

      public TS getCer28_RenewalDate()
      Returns CER-28: "Renewal Date" - creates it if necessary

    • getRevocationDate

      public TS getRevocationDate()
      Returns CER-29: "Revocation Date" - creates it if necessary

    • getCer29_RevocationDate

      public TS getCer29_RevocationDate()
      Returns CER-29: "Revocation Date" - creates it if necessary

    • getRevocationReasonCode

      public CE getRevocationReasonCode()
      Returns CER-30: "Revocation Reason Code" - creates it if necessary

    • getCer30_RevocationReasonCode

      public CE getCer30_RevocationReasonCode()
      Returns CER-30: "Revocation Reason Code" - creates it if necessary

    • getCertificateStatus

      public CWE getCertificateStatus()
      Returns CER-31: "Certificate Status" - creates it if necessary

    • getCer31_CertificateStatus

      public CWE getCer31_CertificateStatus()
      Returns CER-31: "Certificate Status" - creates it if necessary

    • createNewTypeWithoutReflection

      protected Type createNewTypeWithoutReflection(int field)
      Overrides:
      createNewTypeWithoutReflection in class AbstractSegment