ca.uhn.hl7v2.model.v24.segment
Class PDC

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.PDC

All Implemented Interfaces:

Segment, Structure, Serializable

public class PDC
extends AbstractSegment

Represents an HL7 PDC message segment (Product Detail Country). This segment has the following fields:

• PDC-1: Manufacturer/Distributor (XON) repeating
• PDC-2: Country (CE)
• PDC-3: Brand Name (ST)
• PDC-4: Device Family Name (ST) optional
• PDC-5: Generic Name (CE) optional
• PDC-6: Model Identifier (ST) optional repeating
• PDC-7: Catalogue Identifier (ST) optional
• PDC-8: Other Identifier (ST) optional repeating
• PDC-9: Product Code (CE) 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 (TS) optional
• PDC-15: Date Last Marketed (TS) optional

See Also:

Serialized Form

Constructor Summary

PDC(Group parent, ModelClassFactory factory)
Creates a new PDC segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
ST	getBrandName() Returns PDC-3: "Brand Name" - creates it if necessary
ST	getCatalogueIdentifier() Returns PDC-7: "Catalogue Identifier" - creates it if necessary
CE	getCountry() Returns PDC-2: "Country" - creates it if necessary
TS	getDateFirstMarketed() Returns PDC-14: "Date First Marketed" - creates it if necessary
TS	getDateLastMarketed() Returns PDC-15: "Date Last Marketed" - creates it if necessary
ST	getDeviceFamilyName() Returns PDC-4: "Device Family Name" - creates it if necessary
CQ	getExpectedShelfLife() Returns PDC-13: "Expected Shelf Life" - creates it if necessary
CE	getGenericName() Returns PDC-5: "Generic Name" - creates it if necessary
CQ	getLabeledShelfLife() Returns PDC-12: "Labeled Shelf Life" - creates it if necessary
XON[]	getManufacturerDistributor() Returns all repetitions of Manufacturer/Distributor (PDC-1).
XON	getManufacturerDistributor(int rep) Returns a specific repetition of PDC-1: "Manufacturer/Distributor" - creates it if necessary
int	getManufacturerDistributorReps() Returns a count of the current number of repetitions of Manufacturer/Distributor (PDC-1).
ST	getMarketingApprovalID() Returns PDC-11: "Marketing Approval ID" - creates it if necessary
ID	getMarketingBasis() Returns PDC-10: "Marketing Basis" - creates it if necessary
ST[]	getModelIdentifier() Returns all repetitions of Model Identifier (PDC-6).
ST	getModelIdentifier(int rep) Returns a specific repetition of PDC-6: "Model Identifier" - creates it if necessary
int	getModelIdentifierReps() Returns a count of the current number of repetitions of Model Identifier (PDC-6).
ST[]	getOtherIdentifier() Returns all repetitions of Other Identifier (PDC-8).
ST	getOtherIdentifier(int rep) Returns a specific repetition of PDC-8: "Other Identifier" - creates it if necessary
int	getOtherIdentifierReps() Returns a count of the current number of repetitions of Other Identifier (PDC-8).
XON	getPdc1_ManufacturerDistributor(int rep) Returns a specific repetition of PDC-1: "Manufacturer/Distributor" - creates it if necessary
int	getPdc1_ManufacturerDistributorReps() Returns a count of the current number of repetitions of Manufacturer/Distributor (PDC-1).
ID	getPdc10_MarketingBasis() Returns PDC-10: "Marketing Basis" - creates it if necessary
ST	getPdc11_MarketingApprovalID() Returns PDC-11: "Marketing Approval ID" - creates it if necessary
CQ	getPdc12_LabeledShelfLife() Returns PDC-12: "Labeled Shelf Life" - creates it if necessary
CQ	getPdc13_ExpectedShelfLife() Returns PDC-13: "Expected Shelf Life" - creates it if necessary
TS	getPdc14_DateFirstMarketed() Returns PDC-14: "Date First Marketed" - creates it if necessary
TS	getPdc15_DateLastMarketed() Returns PDC-15: "Date Last Marketed" - creates it if necessary
CE	getPdc2_Country() Returns PDC-2: "Country" - creates it if necessary
ST	getPdc3_BrandName() Returns PDC-3: "Brand Name" - creates it if necessary
ST	getPdc4_DeviceFamilyName() Returns PDC-4: "Device Family Name" - creates it if necessary
CE	getPdc5_GenericName() Returns PDC-5: "Generic Name" - creates it if necessary
ST	getPdc6_ModelIdentifier(int rep) Returns a specific repetition of PDC-6: "Model Identifier" - creates it if necessary
int	getPdc6_ModelIdentifierReps() Returns a count of the current number of repetitions of Model Identifier (PDC-6).
ST	getPdc7_CatalogueIdentifier() Returns PDC-7: "Catalogue Identifier" - creates it if necessary
ST	getPdc8_OtherIdentifier(int rep) Returns a specific repetition of PDC-8: "Other Identifier" - creates it if necessary
int	getPdc8_OtherIdentifierReps() Returns a count of the current number of repetitions of Other Identifier (PDC-8).
CE	getPdc9_ProductCode() Returns PDC-9: "Product Code" - creates it if necessary
CE	getProductCode() Returns PDC-9: "Product Code" - creates it if necessary
XON	insertManufacturerDistributor(int rep) Inserts a repetition of PDC-1: "Manufacturer/Distributor" at a specific index
ST	insertModelIdentifier(int rep) Inserts a repetition of PDC-6: "Model Identifier" at a specific index
ST	insertOtherIdentifier(int rep) Inserts a repetition of PDC-8: "Other Identifier" at a specific index
XON	insertPdc1_ManufacturerDistributor(int rep) Inserts a repetition of PDC-1: "Manufacturer/Distributor" at a specific index
ST	insertPdc6_ModelIdentifier(int rep) Inserts a repetition of PDC-6: "Model Identifier" at a specific index
ST	insertPdc8_OtherIdentifier(int rep) Inserts a repetition of PDC-8: "Other Identifier" at a specific index
XON	removeManufacturerDistributor(int rep) Removes a repetition of PDC-1: "Manufacturer/Distributor" at a specific index
ST	removeModelIdentifier(int rep) Removes a repetition of PDC-6: "Model Identifier" at a specific index
ST	removeOtherIdentifier(int rep) Removes a repetition of PDC-8: "Other Identifier" at a specific index
XON	removePdc1_ManufacturerDistributor(int rep) Removes a repetition of PDC-1: "Manufacturer/Distributor" at a specific index
ST	removePdc6_ModelIdentifier(int rep) Removes a repetition of PDC-6: "Model Identifier" at a specific index
ST	removePdc8_OtherIdentifier(int rep) Removes a repetition of PDC-8: "Other Identifier" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PDC

public PDC(Group parent,
           ModelClassFactory factory)

Creates a new PDC segment

Method Detail

getManufacturerDistributor

public XON[] getManufacturerDistributor()

Returns all repetitions of Manufacturer/Distributor (PDC-1).

getManufacturerDistributorReps

public int getManufacturerDistributorReps()

Returns a count of the current number of repetitions of Manufacturer/Distributor (PDC-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getManufacturerDistributor

public XON getManufacturerDistributor(int rep)

Returns a specific repetition of PDC-1: "Manufacturer/Distributor" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPdc1_ManufacturerDistributor

public XON getPdc1_ManufacturerDistributor(int rep)

Returns a specific repetition of PDC-1: "Manufacturer/Distributor" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPdc1_ManufacturerDistributorReps

public int getPdc1_ManufacturerDistributorReps()

Returns a count of the current number of repetitions of Manufacturer/Distributor (PDC-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertManufacturerDistributor

public XON insertManufacturerDistributor(int rep)
                                  throws HL7Exception

Inserts a repetition of PDC-1: "Manufacturer/Distributor" 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)

insertPdc1_ManufacturerDistributor

public XON insertPdc1_ManufacturerDistributor(int rep)
                                       throws HL7Exception

Inserts a repetition of PDC-1: "Manufacturer/Distributor" 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)

removeManufacturerDistributor

public XON removeManufacturerDistributor(int rep)
                                  throws HL7Exception

Removes a repetition of PDC-1: "Manufacturer/Distributor" 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)

removePdc1_ManufacturerDistributor

public XON removePdc1_ManufacturerDistributor(int rep)
                                       throws HL7Exception

Removes a repetition of PDC-1: "Manufacturer/Distributor" 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)

getCountry

public CE getCountry()

Returns PDC-2: "Country" - creates it if necessary

getPdc2_Country

public CE getPdc2_Country()

Returns PDC-2: "Country" - creates it if necessary

getBrandName

public ST getBrandName()

Returns PDC-3: "Brand Name" - creates it if necessary

getPdc3_BrandName

public ST getPdc3_BrandName()

Returns PDC-3: "Brand Name" - creates it if necessary

getDeviceFamilyName

public ST getDeviceFamilyName()

Returns PDC-4: "Device Family Name" - creates it if necessary

getPdc4_DeviceFamilyName

public ST getPdc4_DeviceFamilyName()

Returns PDC-4: "Device Family Name" - creates it if necessary

getGenericName

public CE getGenericName()

Returns PDC-5: "Generic Name" - creates it if necessary

getPdc5_GenericName

public CE getPdc5_GenericName()

Returns PDC-5: "Generic Name" - creates it if necessary

getModelIdentifier

public ST[] getModelIdentifier()

Returns all repetitions of Model Identifier (PDC-6).

getModelIdentifierReps

public int getModelIdentifierReps()

Returns a count of the current number of repetitions of Model Identifier (PDC-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getModelIdentifier

public ST getModelIdentifier(int rep)

Returns a specific repetition of PDC-6: "Model Identifier" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPdc6_ModelIdentifier

public ST getPdc6_ModelIdentifier(int rep)

Returns a specific repetition of PDC-6: "Model Identifier" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPdc6_ModelIdentifierReps

public int getPdc6_ModelIdentifierReps()

Returns a count of the current number of repetitions of Model Identifier (PDC-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertModelIdentifier

public ST insertModelIdentifier(int rep)
                         throws HL7Exception

Inserts a repetition of PDC-6: "Model Identifier" 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)

insertPdc6_ModelIdentifier

public ST insertPdc6_ModelIdentifier(int rep)
                              throws HL7Exception

Inserts a repetition of PDC-6: "Model Identifier" 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)

removeModelIdentifier

public ST removeModelIdentifier(int rep)
                         throws HL7Exception

Removes a repetition of PDC-6: "Model Identifier" 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)

removePdc6_ModelIdentifier

public ST removePdc6_ModelIdentifier(int rep)
                              throws HL7Exception

Removes a repetition of PDC-6: "Model Identifier" 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)

getCatalogueIdentifier

public ST getCatalogueIdentifier()

Returns PDC-7: "Catalogue Identifier" - creates it if necessary

getPdc7_CatalogueIdentifier

public ST getPdc7_CatalogueIdentifier()

Returns PDC-7: "Catalogue Identifier" - creates it if necessary

getOtherIdentifier

public ST[] getOtherIdentifier()

Returns all repetitions of Other Identifier (PDC-8).

getOtherIdentifierReps

public int getOtherIdentifierReps()

Returns a count of the current number of repetitions of Other Identifier (PDC-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getOtherIdentifier

public ST getOtherIdentifier(int rep)

Returns a specific repetition of PDC-8: "Other Identifier" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPdc8_OtherIdentifier

public ST getPdc8_OtherIdentifier(int rep)

Returns a specific repetition of PDC-8: "Other Identifier" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPdc8_OtherIdentifierReps

public int getPdc8_OtherIdentifierReps()

Returns a count of the current number of repetitions of Other Identifier (PDC-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertOtherIdentifier

public ST insertOtherIdentifier(int rep)
                         throws HL7Exception

Inserts a repetition of PDC-8: "Other Identifier" 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)

insertPdc8_OtherIdentifier

public ST insertPdc8_OtherIdentifier(int rep)
                              throws HL7Exception

Inserts a repetition of PDC-8: "Other Identifier" 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)

removeOtherIdentifier

public ST removeOtherIdentifier(int rep)
                         throws HL7Exception

Removes a repetition of PDC-8: "Other Identifier" 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)

removePdc8_OtherIdentifier

public ST removePdc8_OtherIdentifier(int rep)
                              throws HL7Exception

Removes a repetition of PDC-8: "Other Identifier" 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)

getProductCode

public CE getProductCode()

Returns PDC-9: "Product Code" - creates it if necessary

getPdc9_ProductCode

public CE getPdc9_ProductCode()

Returns PDC-9: "Product Code" - creates it if necessary

getMarketingBasis

public ID getMarketingBasis()

Returns PDC-10: "Marketing Basis" - creates it if necessary

getPdc10_MarketingBasis

public ID getPdc10_MarketingBasis()

Returns PDC-10: "Marketing Basis" - creates it if necessary

getMarketingApprovalID

public ST getMarketingApprovalID()

Returns PDC-11: "Marketing Approval ID" - creates it if necessary

getPdc11_MarketingApprovalID

public ST getPdc11_MarketingApprovalID()

Returns PDC-11: "Marketing Approval ID" - creates it if necessary

getLabeledShelfLife

public CQ getLabeledShelfLife()

Returns PDC-12: "Labeled Shelf Life" - creates it if necessary

getPdc12_LabeledShelfLife

public CQ getPdc12_LabeledShelfLife()

Returns PDC-12: "Labeled Shelf Life" - creates it if necessary

getExpectedShelfLife

public CQ getExpectedShelfLife()

Returns PDC-13: "Expected Shelf Life" - creates it if necessary

getPdc13_ExpectedShelfLife

public CQ getPdc13_ExpectedShelfLife()

Returns PDC-13: "Expected Shelf Life" - creates it if necessary

getDateFirstMarketed

public TS getDateFirstMarketed()

Returns PDC-14: "Date First Marketed" - creates it if necessary

getPdc14_DateFirstMarketed

public TS getPdc14_DateFirstMarketed()

Returns PDC-14: "Date First Marketed" - creates it if necessary

getDateLastMarketed

public TS getDateLastMarketed()

Returns PDC-15: "Date Last Marketed" - creates it if necessary

getPdc15_DateLastMarketed

public TS getPdc15_DateLastMarketed()

Returns PDC-15: "Date Last Marketed" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment