com.pixelmed.dicom

Class CodingSchemeIdentification

java.lang.Object

com.pixelmed.dicom.CodingSchemeIdentification

public class CodingSchemeIdentification
extends java.lang.Object

A class to encapsulate the information related to Coding Scheme Identification encoded in composite instances within CodingSchemeIdentificationSequence.

Includes a "dictionary" of various commonly used coding schemes and mappings between their CodingSchemeDesignators and OIDs, as well as convenience methods to add and extract what coding schemes are used within an instance.

Field Summary

Fields

Modifier and Type	Field and Description
static CodingSchemeIdentificationItem	ACR
static CodingSchemeIdentificationItem	ASTM_SIG
static CodingSchemeIdentificationItem	C4
static CodingSchemeIdentificationItem	C5
static CodingSchemeIdentificationItem	caDSR
static CodingSchemeIdentificationItem	CD2
static CodingSchemeIdentificationItem	CTV3
static CodingSchemeIdentificationItem	DC
static CodingSchemeIdentificationItem	DCM
static CodingSchemeIdentificationItem	DCMUID
static CodingSchemeIdentificationItem	FMA
static CodingSchemeIdentificationItem	HPC
static CodingSchemeIdentificationItem	I10
static CodingSchemeIdentificationItem	I10C
static CodingSchemeIdentificationItem	I10P
static CodingSchemeIdentificationItem	I11
static CodingSchemeIdentificationItem	I9
static CodingSchemeIdentificationItem	I9C
static CodingSchemeIdentificationItem	IBSI
static CodingSchemeIdentificationItem	ICDO3
static CodingSchemeIdentificationItem	ISO3166_1
static CodingSchemeIdentificationItem	ISO639_1
static CodingSchemeIdentificationItem	ISO639_2
static CodingSchemeIdentificationItem	ITIS_TSN
protected static CodingSchemeIdentificationItem[]	knownCodingSchemes
protected java.util.List<CodingSchemeIdentificationItem>	listOfItems
static CodingSchemeIdentificationItem	LN
static CodingSchemeIdentificationItem	MA
static CodingSchemeIdentificationItem	MAYOASRG
static CodingSchemeIdentificationItem	MDC
static CodingSchemeIdentificationItem	MGI
static CodingSchemeIdentificationItem	MSH
static CodingSchemeIdentificationItem	NBD
static CodingSchemeIdentificationItem	NBG
static CodingSchemeIdentificationItem	NCIt
static CodingSchemeIdentificationItem	NDC
static CodingSchemeIdentificationItem	NEU
static CodingSchemeIdentificationItem	NICIP
static CodingSchemeIdentificationItem	NYUMCCG
static CodingSchemeIdentificationItem	PATHLEX
static CodingSchemeIdentificationItem	POS
static CodingSchemeIdentificationItem	Private_99_OFFIS_DCMTK
static CodingSchemeIdentificationItem	Private_99IPCMR
static CodingSchemeIdentificationItem	Private_99PMP
static CodingSchemeIdentificationItem	Private_99QIICR
static CodingSchemeIdentificationItem	PUBCHEM_CID
static CodingSchemeIdentificationItem	RADELEMENT
static CodingSchemeIdentificationItem	RADLEX
static java.lang.String	REGISTRY_HL7
static CodingSchemeIdentificationItem	RFC3066
static CodingSchemeIdentificationItem	RFC5646
static CodingSchemeIdentificationItem	RO
static CodingSchemeIdentificationItem	RXNORM
static CodingSchemeIdentificationItem	SCT
static CodingSchemeIdentificationItem	SDM
static CodingSchemeIdentificationItem	SNM3
static CodingSchemeIdentificationItem	SRT
static CodingSchemeIdentificationItem	UBERON
static CodingSchemeIdentificationItem	UCUM
static CodingSchemeIdentificationItem	UMLS
static CodingSchemeIdentificationItem	UPC

Constructor Summary

Constructors

Constructor and Description
CodingSchemeIdentification(AttributeList list) Construct a CodingSchemeIdentification instance from the CodingSchemeIdentificationSequence in the supplied list.
CodingSchemeIdentification(java.util.List<CodingSchemeIdentificationItem> listOfItems) Construct a CodingSchemeIdentification from a list of CodingSchemeIdentificationItems.

Method Summary

Modifier and Type	Method and Description
SequenceAttribute	getAsSequenceAttribute() Get as a CodingSchemeIdentificationSequence attribute.
CodingSchemeIdentificationItem	getByCodingSchemeDesignator(java.lang.String codingSchemeDesignator) Get details of a particular coding scheme by looking up by CodingSchemeDesignator value.
static CodingSchemeIdentification	getCodingSchemesFromExistingAttributeList(AttributeList list) Build a new CodingSchemeIdentification instance by examining all uses of CodedSequenceItems within the supplied list.
protected static CodingSchemeIdentificationItem	lookupByCodingSchemeDesignator(java.lang.String csd)
protected static void	recursivelyCollectCodingSchemeDesignators(AttributeList list, java.util.Set<java.lang.String> schemesFound)
static void	replaceCodingSchemeIdentificationSequenceWithCodingSchemesUsedInAttributeList(AttributeList list) Replace any existing CodingSchemeIdentificationSequence in the list with information gathered by examining all uses of CodedSequenceItems within the list.

Methods inherited from class java.lang.Object

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

Field Detail

ACR

public static final CodingSchemeIdentificationItem ACR

ASTM_SIG

public static final CodingSchemeIdentificationItem ASTM_SIG

C4

public static final CodingSchemeIdentificationItem C4

C5

public static final CodingSchemeIdentificationItem C5

caDSR

public static final CodingSchemeIdentificationItem caDSR

CD2

public static final CodingSchemeIdentificationItem CD2

CTV3

public static final CodingSchemeIdentificationItem CTV3

DC

public static final CodingSchemeIdentificationItem DC

DCM

public static final CodingSchemeIdentificationItem DCM

DCMUID

public static final CodingSchemeIdentificationItem DCMUID

FMA

public static final CodingSchemeIdentificationItem FMA

HPC

public static final CodingSchemeIdentificationItem HPC

I10

public static final CodingSchemeIdentificationItem I10

I10C

public static final CodingSchemeIdentificationItem I10C

I10P

public static final CodingSchemeIdentificationItem I10P

I11

public static final CodingSchemeIdentificationItem I11

I9

public static final CodingSchemeIdentificationItem I9

I9C

public static final CodingSchemeIdentificationItem I9C

IBSI

public static final CodingSchemeIdentificationItem IBSI

ICDO3

public static final CodingSchemeIdentificationItem ICDO3

ISO3166_1

public static final CodingSchemeIdentificationItem ISO3166_1

ISO639_1

public static final CodingSchemeIdentificationItem ISO639_1

ISO639_2

public static final CodingSchemeIdentificationItem ISO639_2

ITIS_TSN

public static final CodingSchemeIdentificationItem ITIS_TSN

knownCodingSchemes

protected static CodingSchemeIdentificationItem[] knownCodingSchemes

listOfItems

protected java.util.List<CodingSchemeIdentificationItem> listOfItems

LN

public static final CodingSchemeIdentificationItem LN

MA

public static final CodingSchemeIdentificationItem MA

MAYOASRG

public static final CodingSchemeIdentificationItem MAYOASRG

MDC

public static final CodingSchemeIdentificationItem MDC

MGI

public static final CodingSchemeIdentificationItem MGI

MSH

public static final CodingSchemeIdentificationItem MSH

NBD

public static final CodingSchemeIdentificationItem NBD

NBG

public static final CodingSchemeIdentificationItem NBG

NCIt

public static final CodingSchemeIdentificationItem NCIt

NDC

public static final CodingSchemeIdentificationItem NDC

NEU

public static final CodingSchemeIdentificationItem NEU

NICIP

public static final CodingSchemeIdentificationItem NICIP

NYUMCCG

public static final CodingSchemeIdentificationItem NYUMCCG

PATHLEX

public static final CodingSchemeIdentificationItem PATHLEX

POS

public static final CodingSchemeIdentificationItem POS

Private_99_OFFIS_DCMTK

public static final CodingSchemeIdentificationItem Private_99_OFFIS_DCMTK

Private_99IPCMR

public static final CodingSchemeIdentificationItem Private_99IPCMR

Private_99PMP

public static final CodingSchemeIdentificationItem Private_99PMP

Private_99QIICR

public static final CodingSchemeIdentificationItem Private_99QIICR

PUBCHEM_CID

public static final CodingSchemeIdentificationItem PUBCHEM_CID

RADELEMENT

public static final CodingSchemeIdentificationItem RADELEMENT

RADLEX

public static final CodingSchemeIdentificationItem RADLEX

REGISTRY_HL7

public static final java.lang.String REGISTRY_HL7

See Also:

Constant Field Values

RFC3066

public static final CodingSchemeIdentificationItem RFC3066

RFC5646

public static final CodingSchemeIdentificationItem RFC5646

RO

public static final CodingSchemeIdentificationItem RO

RXNORM

public static final CodingSchemeIdentificationItem RXNORM

SCT

public static final CodingSchemeIdentificationItem SCT

SDM

public static final CodingSchemeIdentificationItem SDM

SNM3

public static final CodingSchemeIdentificationItem SNM3

SRT

public static final CodingSchemeIdentificationItem SRT

UBERON

public static final CodingSchemeIdentificationItem UBERON

UCUM

public static final CodingSchemeIdentificationItem UCUM

UMLS

public static final CodingSchemeIdentificationItem UMLS

UPC

public static final CodingSchemeIdentificationItem UPC

Constructor Detail

CodingSchemeIdentification

public CodingSchemeIdentification(AttributeList list)

Construct a CodingSchemeIdentification instance from the CodingSchemeIdentificationSequence in the supplied list.

Parameters:

list - the list in which to look for the CodingSchemeIdentificationSequence attribute

CodingSchemeIdentification

public CodingSchemeIdentification(java.util.List<CodingSchemeIdentificationItem> listOfItems)

Construct a CodingSchemeIdentification from a list of CodingSchemeIdentificationItems.

Parameters:

listOfItems - may be null if none (yet)

Method Detail

getAsSequenceAttribute

public SequenceAttribute getAsSequenceAttribute()

Get as a CodingSchemeIdentificationSequence attribute.

Returns:

a SequenceAttribute with one item per coding scheme, or null if no coding schemes

getByCodingSchemeDesignator

public CodingSchemeIdentificationItem getByCodingSchemeDesignator(java.lang.String codingSchemeDesignator)

Get details of a particular coding scheme by looking up by CodingSchemeDesignator value.

Parameters:

codingSchemeDesignator - coding scheme designator

Returns:

a CodingSchemeIdentificationItem, or null if not found

getCodingSchemesFromExistingAttributeList

public static CodingSchemeIdentification getCodingSchemesFromExistingAttributeList(AttributeList list)

Build a new CodingSchemeIdentification instance by examining all uses of CodedSequenceItems within the supplied list.

Parameters:

list - the list in which to look for the CodedSequenceItem attribute

Returns:

a new CodingSchemeIdentification, or null if none found

lookupByCodingSchemeDesignator

protected static CodingSchemeIdentificationItem lookupByCodingSchemeDesignator(java.lang.String csd)

recursivelyCollectCodingSchemeDesignators

protected static void recursivelyCollectCodingSchemeDesignators(AttributeList list,
                                                                java.util.Set<java.lang.String> schemesFound)

replaceCodingSchemeIdentificationSequenceWithCodingSchemesUsedInAttributeList

public static void replaceCodingSchemeIdentificationSequenceWithCodingSchemesUsedInAttributeList(AttributeList list)

Replace any existing CodingSchemeIdentificationSequence in the list with information gathered by examining all uses of CodedSequenceItems within the list.

Parameters:

list - the list in which to look for the CodedSequenceItem attribute