Name Flags Card. Type Description & Constraints AD C 1..* AD XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @isNotOrdered, @use, item, useablePeriod Base for all types and resources Logical Container: ClinicalDocument (CDA Class) shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country @nullFlavor 0..1 cs If addr/@nullFlavor is present, none of the address parts are required. @use 0..* cs Identifies which address to use for a given purpose. item country 0..1 ADXP Binding: Country2 (required) state 0..1 ADXP Binding: (unbound) (example): If country is something other than US, the state MAY be present but MAY be bound to different vocabularies Additional Bindings Purpose Documentation USPS Two Letter Alphabetic Codes Required Binding For US Addresses city 0..1 ADXP city is required if nullFlavor is absent postalCode 0..1 ADXP If country is US, shall be a 5-digit or 9-digit zip code (##### or #####-####) streetAddressLine 0..1 ADXP Min: 1, Max: 4 streetAddressLine required if nullFlavor is absent useablePeriod 0..* IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS (USCDI) Care Team Member Role - Previous Address - Current or prior place where a person may have been located or could have been contacted. Documentation for this format
HL7 International - Structured Documents
Reusable address template, for use in US Realm documents
Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.
SHALL contain exactly one [1..1] city (CONF:81-7292).
nullFlavor.exists() or item.city.count() = 1
SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
nullFlavor.exists() or item.country.exists()
**SHALL NOT** have mixed content except for white space (CONF:81-7296)
If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
SHALL have at most one of each: state, city, postalCode, and country
(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
If addr/@nullFlavor is present, none of the address parts are required.
If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information.
Identifies which address to use for a given purpose.
A set of codes advising a system or user which address in a set of like addresses to select for a given purpose.
Historically this was bound to ValueSet PostalAddressUse urn:oid:2.16.840.1.113883.1.11.10637 STATIC 2005-05-01, but this contained 'CONF' which is not allowed by CDA. So the binding has been removed in the current version of C-CDA.
A series of items that constitute the address.
Can only have only one of the possible item elements in each choice
(delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1
Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.
xmlText and nullFlavor are mutually exclusive (one must be present)
Specifies the representation of the binary data that is the content of the binary data value
Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
For character based information the language property specifies the human language of the text.
This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
A sub-unit of a country with limited sovereignty in a federally organized country.
A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".)
city is required if nullFlavor is absent
The name of the city, town, village, or other community or delivery center
If country is US, shall be a 5-digit or 9-digit zip code (##### or #####-####)
A postal code designating a region defined by the postal service.
Min: 1, Max: 4 streetAddressLine required if nullFlavor is absent
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.
The numeric portion of a building number
Name of a roadway or artery recognized by a municipality (including street type and direction)
The base name of a roadway or artery recognized by a municipality (excluding street type and direction)
The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)
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).
The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.
Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor
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
A geographic sub-unit delineated for demographic purposes.
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.
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.
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.
A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.
Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.
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).
Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number
A numbered box located in a post station.
(USCDI) Care Team Member Role - Previous Address - Current or prior place where a person may have been located or could have been contacted.
A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year.
If country is something other than US, the state MAY be present but MAY be bound to different vocabularies
If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. (CONF:81-10024).