public class PDC extends Segment
Represents an HL7 PDC message segment. This segment has the following fields:
PDC-1: Manufacturer/Distributor (XON)Required
PDC-2: Country (CWE)Required
PDC-3: Brand Name (ST)Required
PDC-4: Device Family Name (ST)Optional
PDC-5: Generic Name (CWE)Optional
PDC-6: Model Identifier (ST)Optional
PDC-7: Catalogue Identifier (ST)Optional
PDC-8: Other Identifier (ST)Optional
PDC-9: Product Code (CWE)Optional
PDC-10: Marketing Basis (ID)Optional
PDC-11: Marketing Approval ID (ST)Optional
PDC-12: Labeled Shelf Life (CQ)Optional
PDC-13: Expected Shelf Life (CQ)Optional
PDC-14: Date First Marketed (DTM)Optional
PDC-15: Date Last Marketed (DTM)Optional
This class provides mechanism to validate message against HL7 v 2.8.2 standard. The class provides accessors & mutators for the elements mentioned above. The class has validate method which validates Message against HL7 v 2.8.2 standard.
User can also create Segment through SegmentFactory
| Constructor and Description |
|---|
PDC()
Constructs the PDC segment.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addManufacturerDistributor(java.lang.String strOrganizationName,
CWE objOrganizationNameTypeCode,
HD objAssigningAuthority,
java.lang.String strIdentifierTypeCode,
HD objAssigningFacility,
java.lang.String strNameRepresentationCode,
java.lang.String strOrganizationIdentifier)
Add the Manufacturer Distributor.
|
void |
addManufacturerDistributor(XON objmanufacturerDistributor)
Add the Manufacturer Distributor.
|
void |
addModelIdentifier(ST objmodelIdentifier)
Add the Model Identifier.
|
void |
addModelIdentifier(java.lang.String strModelIdentifier)
Add the Model Identifier.
|
void |
addOtherIdentifier(ST objotherIdentifier)
Add the Other Identifier.
|
void |
addOtherIdentifier(java.lang.String strOtherIdentifier)
Add the Other Identifier.
|
ST |
getBrandName()
Retrieves the Brand Name.
|
ST |
getCatalogueIdentifier()
Retrieves the Catalogue Identifier.
|
CWE |
getCountry()
Retrieves the Country.
|
DTM |
getDateFirstMarketed()
Retrieves the Date First Marketed.
|
DTM |
getDateLastMarketed()
Retrieves the Date Last Marketed.
|
ST |
getDeviceFamilyName()
Retrieves the Device Family Name.
|
CQ |
getExpectedShelfLife()
Retrieves the Expected Shelf Life.
|
CWE |
getGenericName()
Retrieves the Generic Name.
|
CQ |
getLabeledShelfLife()
Retrieves the Labeled Shelf Life.
|
ISingleCollection<XON> |
getManufacturerDistributor()
Retrieves the Manufacturer Distributor.
|
ST |
getMarketingApprovalID()
Retrieves the Marketing Approval ID.
|
ID |
getMarketingBasis()
Retrieves the Marketing Basis.
|
ISingleCollection<ST> |
getModelIdentifier()
Retrieves the Model Identifier.
|
ISingleCollection<ST> |
getOtherIdentifier()
Retrieves the Other Identifier.
|
CWE |
getProductCode()
Retrieves the Product Code.
|
void |
setBrandName(ST objbrandName)
Set the Brand Name.
|
void |
setBrandName(java.lang.String strBrandName)
Set the Brand Name.
|
void |
setCatalogueIdentifier(ST objcatalogueIdentifier)
Set the Catalogue Identifier.
|
void |
setCatalogueIdentifier(java.lang.String strCatalogueIdentifier)
Set the Catalogue Identifier.
|
void |
setCountry(CWE objcountry)
Set the Country.
|
void |
setCountry(java.lang.String strIdentifier,
java.lang.String strText,
java.lang.String strNameOfCodingSystem,
java.lang.String strAlternateIdentifier,
java.lang.String strAlternateText,
java.lang.String strNameOfAlternateCodingSystem,
java.lang.String strCodingSystemVersionID,
java.lang.String strAlternateCodingSystemVersionId,
java.lang.String strOriginalText,
java.lang.String strSecondAlternateIdentifier,
java.lang.String strSecondAlternateText,
java.lang.String strNameofSecondAlternateCodingSystem,
java.lang.String strSecondAlternateCodingSystemVersionID,
java.lang.String strCodingSystemOID,
java.lang.String strValueSetOID,
java.lang.String strValueSetVersionID,
java.lang.String strAlternateCodingSystemOID,
java.lang.String strAlternateValueSetOID,
java.lang.String strAlternateValueSetVersionID,
java.lang.String strSecondAlternateCodingSystemOID,
java.lang.String strSecondAlternateValueSetOID,
java.lang.String strSecondAlternateValueSetVersionID)
Set the Country.
|
void |
setDateFirstMarketed(DTM objdateFirstMarketed)
Set the Date First Marketed.
|
void |
setDateFirstMarketed(java.lang.String strTime)
Set the Date First Marketed.
|
void |
setDateLastMarketed(DTM objdateLastMarketed)
Set the Date Last Marketed.
|
void |
setDateLastMarketed(java.lang.String strTime)
Set the Date Last Marketed.
|
void |
setDeviceFamilyName(ST objdeviceFamilyName)
Set the Device Family Name.
|
void |
setDeviceFamilyName(java.lang.String strDeviceFamilyName)
Set the Device Family Name.
|
void |
setExpectedShelfLife(CQ objexpectedShelfLife)
Set the Expected Shelf Life.
|
void |
setExpectedShelfLife(java.lang.String strQuantity,
CWE objUnits)
Set the Expected Shelf Life.
|
void |
setGenericName(CWE objgenericName)
Set the Generic Name.
|
void |
setGenericName(java.lang.String strIdentifier,
java.lang.String strText,
java.lang.String strNameOfCodingSystem,
java.lang.String strAlternateIdentifier,
java.lang.String strAlternateText,
java.lang.String strNameOfAlternateCodingSystem,
java.lang.String strCodingSystemVersionID,
java.lang.String strAlternateCodingSystemVersionId,
java.lang.String strOriginalText,
java.lang.String strSecondAlternateIdentifier,
java.lang.String strSecondAlternateText,
java.lang.String strNameofSecondAlternateCodingSystem,
java.lang.String strSecondAlternateCodingSystemVersionID,
java.lang.String strCodingSystemOID,
java.lang.String strValueSetOID,
java.lang.String strValueSetVersionID,
java.lang.String strAlternateCodingSystemOID,
java.lang.String strAlternateValueSetOID,
java.lang.String strAlternateValueSetVersionID,
java.lang.String strSecondAlternateCodingSystemOID,
java.lang.String strSecondAlternateValueSetOID,
java.lang.String strSecondAlternateValueSetVersionID)
Set the Generic Name.
|
void |
setLabeledShelfLife(CQ objlabeledShelfLife)
Set the Labeled Shelf Life.
|
void |
setLabeledShelfLife(java.lang.String strQuantity,
CWE objUnits)
Set the Labeled Shelf Life.
|
void |
setManufacturerDistributor(ISingleCollection<XON> objmanufacturerDistributorList)
Set the Manufacturer Distributor.
|
void |
setMarketingApprovalID(ST objmarketingApprovalID)
Set the Marketing Approval ID.
|
void |
setMarketingApprovalID(java.lang.String strMarketingApprovalID)
Set the Marketing Approval ID.
|
void |
setMarketingBasis(ID objmarketingBasis)
Set the Marketing Basis.
|
void |
setMarketingBasis(java.lang.String strMarketingBasis)
Set the Marketing Basis.
|
void |
setModelIdentifier(ISingleCollection<ST> objmodelIdentifierList)
Set the Model Identifier.
|
void |
setOtherIdentifier(ISingleCollection<ST> objotherIdentifierList)
Set the Other Identifier.
|
void |
setProductCode(CWE objproductCode)
Set the Product Code.
|
void |
setProductCode(java.lang.String strIdentifier,
java.lang.String strText,
java.lang.String strNameOfCodingSystem,
java.lang.String strAlternateIdentifier,
java.lang.String strAlternateText,
java.lang.String strNameOfAlternateCodingSystem,
java.lang.String strCodingSystemVersionID,
java.lang.String strAlternateCodingSystemVersionId,
java.lang.String strOriginalText,
java.lang.String strSecondAlternateIdentifier,
java.lang.String strSecondAlternateText,
java.lang.String strNameofSecondAlternateCodingSystem,
java.lang.String strSecondAlternateCodingSystemVersionID,
java.lang.String strCodingSystemOID,
java.lang.String strValueSetOID,
java.lang.String strValueSetVersionID,
java.lang.String strAlternateCodingSystemOID,
java.lang.String strAlternateValueSetOID,
java.lang.String strAlternateValueSetVersionID,
java.lang.String strSecondAlternateCodingSystemOID,
java.lang.String strSecondAlternateValueSetOID,
java.lang.String strSecondAlternateValueSetVersionID)
Set the Product Code.
|
boolean |
validate()
Validates HL7 Message objects .
|
addUnRecognizedField, dumpSegment, getFields, getName, getUnrecognizedFields, moveToNextSegment, parse, removeDataElement, removeDataElement, serialize, setName, setUnRecognizedField, updateDataElement, updateDataElement, writeToXMLpublic ST getBrandName()
public ST getCatalogueIdentifier()
public CWE getCountry()
public DTM getDateFirstMarketed()
public DTM getDateLastMarketed()
public ST getDeviceFamilyName()
public CQ getExpectedShelfLife()
public CWE getGenericName()
public CQ getLabeledShelfLife()
public ISingleCollection<XON> getManufacturerDistributor()
public ST getMarketingApprovalID()
public ID getMarketingBasis()
public ISingleCollection<ST> getModelIdentifier()
public ISingleCollection<ST> getOtherIdentifier()
public CWE getProductCode()
public void setBrandName(java.lang.String strBrandName)
strBrandName - This field contains the String Value of Brand Namepublic void setBrandName(ST objbrandName)
objbrandName - Object of Brand Name.public void setCatalogueIdentifier(java.lang.String strCatalogueIdentifier)
strCatalogueIdentifier - This field contains the String Value of Catalogue Identifierpublic void setCatalogueIdentifier(ST objcatalogueIdentifier)
objcatalogueIdentifier - Object of Catalogue Identifier.public void setCountry(java.lang.String strIdentifier,
java.lang.String strText,
java.lang.String strNameOfCodingSystem,
java.lang.String strAlternateIdentifier,
java.lang.String strAlternateText,
java.lang.String strNameOfAlternateCodingSystem,
java.lang.String strCodingSystemVersionID,
java.lang.String strAlternateCodingSystemVersionId,
java.lang.String strOriginalText,
java.lang.String strSecondAlternateIdentifier,
java.lang.String strSecondAlternateText,
java.lang.String strNameofSecondAlternateCodingSystem,
java.lang.String strSecondAlternateCodingSystemVersionID,
java.lang.String strCodingSystemOID,
java.lang.String strValueSetOID,
java.lang.String strValueSetVersionID,
java.lang.String strAlternateCodingSystemOID,
java.lang.String strAlternateValueSetOID,
java.lang.String strAlternateValueSetVersionID,
java.lang.String strSecondAlternateCodingSystemOID,
java.lang.String strSecondAlternateValueSetOID,
java.lang.String strSecondAlternateValueSetVersionID)
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction.strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.strCodingSystemVersionID - A sequence of characters that uniquely identifies a second alternate code.strAlternateCodingSystemVersionId - This component carries the version for the coding system identified by components 4-6.strOriginalText - The text as seen and/or selected by the user who entered the data.strSecondAlternateIdentifier - A sequence of characters that uniquely identifies a second alternate code.strSecondAlternateText - The descriptive or textual name of the alternate identifier.strNameofSecondAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.strSecondAlternateCodingSystemVersionID - This component carries the version for the coding system identified by components 10-12.strCodingSystemOID - This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.3.strValueSetOID - This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.1 is obtained.strValueSetVersionID - This component carries the version for the value set identified by CWE.15. The version is a date. The date is the date/time that the value set being used was published.strAlternateCodingSystemOID - This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.6.strAlternateValueSetOID - This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.4 is obtained.strAlternateValueSetVersionID - This component carries the version for the value set identified by CWE.18. The version is a date.strSecondAlternateCodingSystemOID - This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.12.strSecondAlternateValueSetOID - This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.10 is obtained.strSecondAlternateValueSetVersionID - This component carries the version for the value set identified by CWE.21. The version is a date.public void setCountry(CWE objcountry)
objcountry - Object of Country.public void setDateFirstMarketed(java.lang.String strTime)
strTime - Specifies a point in time using a 24-hour clock notation.public void setDateFirstMarketed(DTM objdateFirstMarketed)
objdateFirstMarketed - OBject of Date First Marketed.public void setDateLastMarketed(java.lang.String strTime)
strTime - Specifies a point in time using a 24-hour clock notation.public void setDateLastMarketed(DTM objdateLastMarketed)
objdateLastMarketed - Object of Date Last Marketed.public void setDeviceFamilyName(java.lang.String strDeviceFamilyName)
strDeviceFamilyName - This field contains the String Value of Device Family Namepublic void setDeviceFamilyName(ST objdeviceFamilyName)
objdeviceFamilyName - object of Device Family Name.public void setExpectedShelfLife(java.lang.String strQuantity,
CWE objUnits)
strQuantity - Specifies the numeric quantity or amount of an entity.objUnits - Specifies the units in which the quantity is expressed.public void setExpectedShelfLife(CQ objexpectedShelfLife)
objexpectedShelfLife - Object of Expected Shelf Life.public void setGenericName(java.lang.String strIdentifier,
java.lang.String strText,
java.lang.String strNameOfCodingSystem,
java.lang.String strAlternateIdentifier,
java.lang.String strAlternateText,
java.lang.String strNameOfAlternateCodingSystem,
java.lang.String strCodingSystemVersionID,
java.lang.String strAlternateCodingSystemVersionId,
java.lang.String strOriginalText,
java.lang.String strSecondAlternateIdentifier,
java.lang.String strSecondAlternateText,
java.lang.String strNameofSecondAlternateCodingSystem,
java.lang.String strSecondAlternateCodingSystemVersionID,
java.lang.String strCodingSystemOID,
java.lang.String strValueSetOID,
java.lang.String strValueSetVersionID,
java.lang.String strAlternateCodingSystemOID,
java.lang.String strAlternateValueSetOID,
java.lang.String strAlternateValueSetVersionID,
java.lang.String strSecondAlternateCodingSystemOID,
java.lang.String strSecondAlternateValueSetOID,
java.lang.String strSecondAlternateValueSetVersionID)
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction.strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.strCodingSystemVersionID - A sequence of characters that uniquely identifies a second alternate code.strAlternateCodingSystemVersionId - This component carries the version for the coding system identified by components 4-6.strOriginalText - The text as seen and/or selected by the user who entered the data.strSecondAlternateIdentifier - A sequence of characters that uniquely identifies a second alternate code.strSecondAlternateText - The descriptive or textual name of the alternate identifier.strNameofSecondAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.strSecondAlternateCodingSystemVersionID - This component carries the version for the coding system identified by components 10-12.strCodingSystemOID - This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.3.strValueSetOID - This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.1 is obtained.strValueSetVersionID - This component carries the version for the value set identified by CWE.15. The version is a date. The date is the date/time that the value set being used was published.strAlternateCodingSystemOID - This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.6.strAlternateValueSetOID - This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.4 is obtained.strAlternateValueSetVersionID - This component carries the version for the value set identified by CWE.18. The version is a date.strSecondAlternateCodingSystemOID - This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.12.strSecondAlternateValueSetOID - This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.10 is obtained.strSecondAlternateValueSetVersionID - This component carries the version for the value set identified by CWE.21. The version is a date.public void setGenericName(CWE objgenericName)
objgenericName - Object of Generic Name.public void setLabeledShelfLife(java.lang.String strQuantity,
CWE objUnits)
strQuantity - Specifies the numeric quantity or amount of an entity.objUnits - Specifies the units in which the quantity is expressed.public void setLabeledShelfLife(CQ objlabeledShelfLife)
objlabeledShelfLife - Object of Labeled Shelf Life.public void addManufacturerDistributor(java.lang.String strOrganizationName,
CWE objOrganizationNameTypeCode,
HD objAssigningAuthority,
java.lang.String strIdentifierTypeCode,
HD objAssigningFacility,
java.lang.String strNameRepresentationCode,
java.lang.String strOrganizationIdentifier)
strOrganizationName - Specifies name of the specified organization.strOrganizationNameTypeCode - Specifies a code that represents the type of name i.e., legal name, display name.
Suggested Values A,L,D,SL.[Refer to table No.0204]objAssigningAuthority - Specifies The assigning authority is a unique identifier of the system
(or organization or agency or department) that creates the data.strIdentifierTypeCode - Specifies a code corresponding to the type of identifier.objAssigningFacility - Specifies The place or location identifier where the identifier was first assigned to the person.strNameRepresentationCode - Specifies representations of the same name/address Suggested values are I,A,P [Refer table 0465]strOrganizationIdentifier - This component contains the sequence of characters (the code) that uniquely
identifies the item being referenced by XON.1 Organization Name.
This component replaces XON.3 ID Number as of v 2.5.public void addManufacturerDistributor(XON objmanufacturerDistributor)
objmanufacturerDistributor - Object of Manufacturer Distributor.public void setManufacturerDistributor(ISingleCollection<XON> objmanufacturerDistributorList)
objmanufacturerDistributorList - List of Manufacturer Distributor.public void setMarketingApprovalID(java.lang.String strMarketingApprovalID)
strMarketingApprovalID - This field contains the String Value of Marketing Approval IDpublic void setMarketingApprovalID(ST objmarketingApprovalID)
objmarketingApprovalID - Object of Marketing Approval ID.public void setMarketingBasis(java.lang.String strMarketingBasis)
strMarketingBasis - This field contains the String Value of Marketing Basispublic void setMarketingBasis(ID objmarketingBasis)
objmarketingBasis - Object of Marketing Basis.public void addModelIdentifier(java.lang.String strModelIdentifier)
strModelIdentifier - This field contains the String Value of Model Identifierpublic void addModelIdentifier(ST objmodelIdentifier)
objmodelIdentifier - Object of Model Identifier.public void setModelIdentifier(ISingleCollection<ST> objmodelIdentifierList)
objmodelIdentifierList - List of Model Identifier.public void addOtherIdentifier(java.lang.String strOtherIdentifier)
strOtherIdentifier - This field contains the String Value of Other Identifierpublic void addOtherIdentifier(ST objotherIdentifier)
objotherIdentifier - Object of Other Identifier.public void setOtherIdentifier(ISingleCollection<ST> objotherIdentifierList)
objotherIdentifierList - List of Other Identifier.public void setProductCode(java.lang.String strIdentifier,
java.lang.String strText,
java.lang.String strNameOfCodingSystem,
java.lang.String strAlternateIdentifier,
java.lang.String strAlternateText,
java.lang.String strNameOfAlternateCodingSystem,
java.lang.String strCodingSystemVersionID,
java.lang.String strAlternateCodingSystemVersionId,
java.lang.String strOriginalText,
java.lang.String strSecondAlternateIdentifier,
java.lang.String strSecondAlternateText,
java.lang.String strNameofSecondAlternateCodingSystem,
java.lang.String strSecondAlternateCodingSystemVersionID,
java.lang.String strCodingSystemOID,
java.lang.String strValueSetOID,
java.lang.String strValueSetVersionID,
java.lang.String strAlternateCodingSystemOID,
java.lang.String strAlternateValueSetOID,
java.lang.String strAlternateValueSetVersionID,
java.lang.String strSecondAlternateCodingSystemOID,
java.lang.String strSecondAlternateValueSetOID,
java.lang.String strSecondAlternateValueSetVersionID)
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infarction.strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.strCodingSystemVersionID - A sequence of characters that uniquely identifies a second alternate code.strAlternateCodingSystemVersionId - This component carries the version for the coding system identified by components 4-6.strOriginalText - The text as seen and/or selected by the user who entered the data.strSecondAlternateIdentifier - A sequence of characters that uniquely identifies a second alternate code.strSecondAlternateText - The descriptive or textual name of the alternate identifier.strNameofSecondAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.strSecondAlternateCodingSystemVersionID - This component carries the version for the coding system identified by components 10-12.strCodingSystemOID - This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.3.strValueSetOID - This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.1 is obtained.strValueSetVersionID - This component carries the version for the value set identified by CWE.15. The version is a date. The date is the date/time that the value set being used was published.strAlternateCodingSystemOID - This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.6.strAlternateValueSetOID - This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.4 is obtained.strAlternateValueSetVersionID - This component carries the version for the value set identified by CWE.18. The version is a date.strSecondAlternateCodingSystemOID - This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.12.strSecondAlternateValueSetOID - This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.10 is obtained.strSecondAlternateValueSetVersionID - This component carries the version for the value set identified by CWE.21. The version is a date.public void setProductCode(CWE objproductCode)
objproductCode - Object of Product Code.public boolean validate()
throws InvalidSegmentException
validate in interface ISegmentvalidate in class SegmentInvalidSegmentException - Throws when Segment Validation fails.