Enum V3AddressPartType
- java.lang.Object
-
- java.lang.Enum<V3AddressPartType>
-
- org.hl7.fhir.r4.model.codesystems.V3AddressPartType
-
- All Implemented Interfaces:
Serializable,Comparable<V3AddressPartType>
public enum V3AddressPartType extends Enum<V3AddressPartType>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ADLThis can be a unit designator, such as apartment number, suite number, or floor.ALDescription: An address line is for either an additional locator, a delivery address or a street address.BNNThe numeric portion of a building numberBNRThe number of a building, house or lot alongside the street.BNSAny alphabetic character, fraction or other text that may appear after the numeric portion of a building numberCARThe name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipientCENA geographic sub-unit delineated for demographic purposes.CNTCountryCPAA sub-unit of a state or province.CTYThe name of the city, town, village, or other community or delivery centerDALA delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc.DELDelimiters are printed without framing white space.DINSTIndicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc.DINSTAThe location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality.DINSTQA number, letter or name identifying a delivery installation.DIRDirection (e.g., N, S, W, E)DMODIndicates the type of service offered, method of delivery.DMODIDRepresents the routing information such as a letter carrier route number.DPIDA value that uniquely identifies the postal address.INTDescription:An intersection denotes that the actual address is located AT or CLOSE TO the intersection OF two or more streets.NULLadded to help the parsersPOBA numbered box located in a post station.PREA subsection of a municipalitySALDescription: A street address line is frequently used instead of breaking out build number, street name, street type, etc.STAA sub-unit of a country with limited sovereignty in a federally organized country.STBThe base name of a roadway or artery recognized by a municipality (excluding street type and direction)STRstreet nameSTTYPThe designation given to the street.UNIDThe number or name of a specific unit contained within a building or complex, as assigned by that building or complex.UNITIndicates the type of specific unit contained within a building or complex.ZIPA postal code designating a region defined by the postal service.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static V3AddressPartTypefromCode(String codeString)StringgetDefinition()StringgetDisplay()StringgetSystem()StringtoCode()static V3AddressPartTypevalueOf(String name)Returns the enum constant of this type with the specified name.static V3AddressPartType[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ADL
public static final V3AddressPartType ADL
This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).
-
AL
public static final V3AddressPartType AL
Description: An address line is for either an additional locator, a delivery address or a street address.
-
DAL
public static final V3AddressPartType DAL
A delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc. An address generally has only a delivery address line or a street address line, but not both.
-
SAL
public static final V3AddressPartType SAL
Description: A street address line is frequently used instead of breaking out build number, street name, street type, etc. An address generally has only a delivery address line or a street address line, but not both.
-
BNN
public static final V3AddressPartType BNN
The numeric portion of a building number
-
BNR
public static final V3AddressPartType BNR
The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.
-
BNS
public static final V3AddressPartType BNS
Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number
-
CAR
public static final V3AddressPartType CAR
The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient
-
CEN
public static final V3AddressPartType CEN
A geographic sub-unit delineated for demographic purposes.
-
CNT
public static final V3AddressPartType CNT
Country
-
CPA
public static final V3AddressPartType CPA
A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".)
-
CTY
public static final V3AddressPartType CTY
The name of the city, town, village, or other community or delivery center
-
DEL
public static final V3AddressPartType DEL
Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.
-
DINST
public static final V3AddressPartType DINST
Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc.
-
DINSTA
public static final V3AddressPartType DINSTA
The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route.
-
DINSTQ
public static final V3AddressPartType DINSTQ
A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.
-
DIR
public static final V3AddressPartType DIR
Direction (e.g., N, S, W, E)
-
DMOD
public static final V3AddressPartType DMOD
Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.
-
DMODID
public static final V3AddressPartType DMODID
Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number).
-
DPID
public static final V3AddressPartType DPID
A value that uniquely identifies the postal address.
-
INT
public static final V3AddressPartType INT
Description:An intersection denotes that the actual address is located AT or CLOSE TO the intersection OF two or more streets.
-
POB
public static final V3AddressPartType POB
A numbered box located in a post station.
-
PRE
public static final V3AddressPartType PRE
A subsection of a municipality
-
STA
public static final V3AddressPartType STA
A sub-unit of a country with limited sovereignty in a federally organized country.
-
STB
public static final V3AddressPartType STB
The base name of a roadway or artery recognized by a municipality (excluding street type and direction)
-
STR
public static final V3AddressPartType STR
street name
-
STTYP
public static final V3AddressPartType STTYP
The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)
-
UNID
public static final V3AddressPartType UNID
The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.
-
UNIT
public static final V3AddressPartType UNIT
Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor
-
ZIP
public static final V3AddressPartType ZIP
A postal code designating a region defined by the postal service.
-
NULL
public static final V3AddressPartType NULL
added to help the parsers
-
-
Method Detail
-
values
public static V3AddressPartType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (V3AddressPartType c : V3AddressPartType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static V3AddressPartType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
fromCode
public static V3AddressPartType fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getDefinition
public String getDefinition()
-
getDisplay
public String getDisplay()
-
-