Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
| Draft as of 2023-09-29 |
XML representation of the USRealmAddressADUSFIELDED logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="USRealmAddressADUSFIELDED"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmAddressADUSFIELDED-definitions.html#AD">AD</a><a name="AD"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints (81-7296)">C</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html">AD</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">XML Namespace: </span>urn:hl7-org:v3<br/>Elements defined in Ancestors: <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-ANY.html" title="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.">@nullFlavor</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.">@nullFlavor</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="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.">@isNotOrdered</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="A set of codes advising a system or user which address in a set of like addresses to select for a given purpose.">@use</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.">delimiter</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="Country">country</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="A sub-unit of a country with limited sovereignty in a federally organized country.">state</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".)">county</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="The name of the city, town, village, or other community or delivery center">city</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="A postal code designating a region defined by the postal service.">postalCode</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="Street address line">streetAddressLine</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="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.">houseNumber</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="The numeric portion of a building number">houseNumberNumeric</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="Direction (e.g., N, S, W, E)">direction</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="Name of a roadway or artery recognized by a municipality (including street type and direction)">streetName</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="The base name of a roadway or artery recognized by a municipality (excluding street type and direction)">streetNameBase</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)">streetNameType</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="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).">additionalLocator</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.">unitID</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor">unitType</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="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">careOf</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="A geographic sub-unit delineated for demographic purposes.">censusTract</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="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.">deliveryAddressLine</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="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.">deliveryInstallationType</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="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.">deliveryInstallationArea</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.">deliveryInstallationQualifier</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.">deliveryMode</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="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).">deliveryModeIdentifier</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number">buildingNumberSuffix</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="A numbered box located in a post station.">postBox</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="A subsection of a municipality">precinct</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="Textual representation of (part of) the address">other</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-AD.html" title="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.">useablePeriod</a><br/><span style="opacity: 0.5">Base for all types and resources</span><br/><span style="font-weight:bold">81-7296: </span>**SHALL NOT** have mixed content except for white space (CONF:81-7296).</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmAddressADUSFIELDED-definitions.html#AD.use">use</a><a name="AD.use"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span>..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-cs-simple.html" title="code">cs</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">If addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced<br/><span style="font-weight:bold">Binding: </span><a href="https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.1.11.10637/expansion">PostalAddressUse</a> (<a href="http://hl7.org/fhir/R5/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">required</a>)</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmAddressADUSFIELDED-definitions.html#AD.country">country</a><a name="AD.country"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span>..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-ADXP.html">ADXP</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.3.88.12.80.63/expansion">VSAC 2.16.840.1.113883.3.88.12.80.63</a> (<a href="http://hl7.org/fhir/R5/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">required</a>)</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmAddressADUSFIELDED-definitions.html#AD.state">state</a><a name="AD.state"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints (81-10024)">C</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span>..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-ADXP.html">ADXP</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.3.88.12.80.1/expansion">VSAC 2.16.840.1.113883.3.88.12.80.1</a> (<a href="http://hl7.org/fhir/R5/terminologies.html#preferred" title="Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.">preferred</a>)<br/><span style="font-weight:bold">81-10024: </span>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).</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmAddressADUSFIELDED-definitions.html#AD.city">city</a><a name="AD.city"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-ADXP.html">ADXP</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmAddressADUSFIELDED-definitions.html#AD.postalCode">postalCode</a><a name="AD.postalCode"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints (81-10025)">C</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span>..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-ADXP.html">ADXP</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.3.88.12.80.2/expansion">VSAC 2.16.840.1.113883.3.88.12.80.2</a> (<a href="http://hl7.org/fhir/R5/terminologies.html#preferred" title="Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.">preferred</a>)<br/><span style="font-weight:bold">81-10025: </span>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).</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmAddressADUSFIELDED-definitions.html#AD.streetAddressLine">streetAddressLine</a><a name="AD.streetAddressLine"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..4</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-ADXP.html">ADXP</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/logical-target">
<valueBoolean>
<extension
url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
<valueCode value="not-applicable"/>
</extension>
</valueBoolean>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:v3"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-no-order">
<valueBoolean value="true"/>
</extension>
<url
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddressADUSFIELDED"/>
<identifier>
<value value="urn:oid:2.16.840.1.113883.10.20.22.5.2"/>
</identifier>
<version value="2.1"/>
<name value="USRealmAddressADUSFIELDED"/>
<title value="US Realm Address (AD.US.FIELDED)"/>
<status value="draft"/>
<date value="2023-09-29T16:20:44+00:00"/>
<publisher value="Health Level Seven"/>
<contact>
<name value="HL7 International - Structured Documents"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/structure"/>
</telecom>
</contact>
<description
value="Reusable address template, for use in US Realm CDA Header."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<fhirVersion value="5.0.0"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type value="http://hl7.org/cda/stds/core/StructureDefinition/AD"/>
<baseDefinition
value="http://hl7.org/cda/stds/core/StructureDefinition/AD"/>
<derivation value="constraint"/>
<snapshot>
<element id="AD">
<path value="AD"/>
<short value="Base for all types and resources"/>
<definition
value="Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc."/>
<min value="1"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="81-7296"/>
<severity value="error"/>
<human
value="**SHALL NOT** have mixed content except for white space (CONF:81-7296)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddressADUSFIELDED"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="AD.nullFlavor">
<path value="AD.nullFlavor"/>
<label value="Exceptional Value Detail"/>
<short value="Primitive Type code"/>
<definition
value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ANY.nullFlavor"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="cs-pattern"/>
<severity value="error"/>
<human value="cs attributes must not contain any whitespace"/>
<expression value="matches('^[^\\s]+$')"/>
<source value="http://hl7.org/cda/stds/core/StructureDefinition/ANY"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-NullFlavor"/>
</binding>
</element>
<element id="AD.isNotOrdered">
<path value="AD.isNotOrdered"/>
<representation value="xmlAttr"/>
<label value="Is Not Ordered"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.isNotOrdered"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"/>
</type>
</element>
<element id="AD.use">
<path value="AD.use"/>
<representation value="xmlAttr"/>
<label value="Use Code"/>
<short
value="If addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced"/>
<definition
value="A set of codes advising a system or user which address in a set of like addresses to select for a given purpose."/>
<comment
value="SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet PostalAddressUse urn:oid:2.16.840.1.113883.1.11.10637 STATIC 2005-05-01 (CONF:81-7290)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.use"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.10637"/>
</binding>
</element>
<element id="AD.delimiter">
<path value="AD.delimiter"/>
<definition
value="Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.delimiter"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.delimiter.partType">
<path value="AD.delimiter.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.delimiter.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="DEL"/>
</element>
<element id="AD.country">
<path value="AD.country"/>
<definition value="Country"/>
<comment
value="SHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:81-7295)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.country"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.country.partType">
<path value="AD.country.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.country.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="CNT"/>
</element>
<element id="AD.state">
<path value="AD.state"/>
<definition
value="A sub-unit of a country with limited sovereignty in a federally organized country."/>
<comment
value="SHOULD contain zero or one [0..1] state, which SHOULD be selected from ValueSet StateValueSet urn:oid:2.16.840.1.113883.3.88.12.80.1 DYNAMIC) (CONF:81-7293)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.state"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
<constraint>
<key value="81-10024"/>
<severity value="error"/>
<human
value="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)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddressADUSFIELDED"/>
</constraint>
</element>
<element id="AD.state.partType">
<path value="AD.state.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.state.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="STA"/>
</element>
<element id="AD.county">
<path value="AD.county"/>
<definition
value="A sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".)"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.county"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.county.partType">
<path value="AD.county.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.county.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="CPA"/>
</element>
<element id="AD.city">
<path value="AD.city"/>
<definition
value="The name of the city, town, village, or other community or delivery center"/>
<comment value="SHALL contain exactly one [1..1] city (CONF:81-7292)."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="AD.city"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.city.partType">
<path value="AD.city.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.city.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="CTY"/>
</element>
<element id="AD.postalCode">
<path value="AD.postalCode"/>
<definition
value="A postal code designating a region defined by the postal service."/>
<comment
value="SHOULD contain zero or one [0..1] postalCode, which SHOULD be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:81-7294)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.postalCode"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
<constraint>
<key value="81-10025"/>
<severity value="error"/>
<human
value="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)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddressADUSFIELDED"/>
</constraint>
</element>
<element id="AD.postalCode.partType">
<path value="AD.postalCode.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.postalCode.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="ZIP"/>
</element>
<element id="AD.streetAddressLine">
<path value="AD.streetAddressLine"/>
<definition value="Street address line"/>
<comment
value="SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291)."/>
<min value="1"/>
<max value="4"/>
<base>
<path value="AD.streetAddressLine"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.streetAddressLine.partType">
<path value="AD.streetAddressLine.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.streetAddressLine.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="SAL"/>
</element>
<element id="AD.houseNumber">
<path value="AD.houseNumber"/>
<definition
value="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."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.houseNumber"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.houseNumber.partType">
<path value="AD.houseNumber.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.houseNumber.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="BNR"/>
</element>
<element id="AD.houseNumberNumeric">
<path value="AD.houseNumberNumeric"/>
<definition value="The numeric portion of a building number"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.houseNumberNumeric"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.houseNumberNumeric.partType">
<path value="AD.houseNumberNumeric.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.houseNumberNumeric.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="BNN"/>
</element>
<element id="AD.direction">
<path value="AD.direction"/>
<definition value="Direction (e.g., N, S, W, E)"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.direction"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.direction.partType">
<path value="AD.direction.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.direction.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="DIR"/>
</element>
<element id="AD.streetName">
<path value="AD.streetName"/>
<definition
value="Name of a roadway or artery recognized by a municipality (including street type and direction)"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.streetName"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.streetName.partType">
<path value="AD.streetName.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.streetName.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="STR"/>
</element>
<element id="AD.streetNameBase">
<path value="AD.streetNameBase"/>
<definition
value="The base name of a roadway or artery recognized by a municipality (excluding street type and direction)"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.streetNameBase"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.streetNameBase.partType">
<path value="AD.streetNameBase.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.streetNameBase.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="STB"/>
</element>
<element id="AD.streetNameType">
<path value="AD.streetNameType"/>
<definition
value="The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.streetNameType"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.streetNameType.partType">
<path value="AD.streetNameType.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.streetNameType.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="STTYP"/>
</element>
<element id="AD.additionalLocator">
<path value="AD.additionalLocator"/>
<definition
value="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)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.additionalLocator"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.additionalLocator.partType">
<path value="AD.additionalLocator.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.additionalLocator.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="ADL"/>
</element>
<element id="AD.unitID">
<path value="AD.unitID"/>
<definition
value="The number or name of a specific unit contained within a building or complex, as assigned by that building or complex."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.unitID"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.unitID.partType">
<path value="AD.unitID.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.unitID.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="UNID"/>
</element>
<element id="AD.unitType">
<path value="AD.unitType"/>
<definition
value="Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.unitType"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.unitType.partType">
<path value="AD.unitType.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.unitType.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="UNIT"/>
</element>
<element id="AD.careOf">
<path value="AD.careOf"/>
<definition
value="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"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.careOf"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.careOf.partType">
<path value="AD.careOf.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.careOf.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="CAR"/>
</element>
<element id="AD.censusTract">
<path value="AD.censusTract"/>
<definition
value="A geographic sub-unit delineated for demographic purposes."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.censusTract"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.censusTract.partType">
<path value="AD.censusTract.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.censusTract.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="CEN"/>
</element>
<element id="AD.deliveryAddressLine">
<path value="AD.deliveryAddressLine"/>
<definition
value="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."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.deliveryAddressLine"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.deliveryAddressLine.partType">
<path value="AD.deliveryAddressLine.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.deliveryAddressLine.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="DAL"/>
</element>
<element id="AD.deliveryInstallationType">
<path value="AD.deliveryInstallationType"/>
<definition
value="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."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.deliveryInstallationType"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.deliveryInstallationType.partType">
<path value="AD.deliveryInstallationType.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.deliveryInstallationType.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="DINST"/>
</element>
<element id="AD.deliveryInstallationArea">
<path value="AD.deliveryInstallationArea"/>
<definition
value="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."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.deliveryInstallationArea"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.deliveryInstallationArea.partType">
<path value="AD.deliveryInstallationArea.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.deliveryInstallationArea.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="DINSTA"/>
</element>
<element id="AD.deliveryInstallationQualifier">
<path value="AD.deliveryInstallationQualifier"/>
<definition
value="A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.deliveryInstallationQualifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.deliveryInstallationQualifier.partType">
<path value="AD.deliveryInstallationQualifier.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.deliveryInstallationQualifier.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="DINSTQ"/>
</element>
<element id="AD.deliveryMode">
<path value="AD.deliveryMode"/>
<definition
value="Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.deliveryMode"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.deliveryMode.partType">
<path value="AD.deliveryMode.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.deliveryMode.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="DMOD"/>
</element>
<element id="AD.deliveryModeIdentifier">
<path value="AD.deliveryModeIdentifier"/>
<definition
value="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)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.deliveryModeIdentifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.deliveryModeIdentifier.partType">
<path value="AD.deliveryModeIdentifier.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.deliveryModeIdentifier.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="DMODID"/>
</element>
<element id="AD.buildingNumberSuffix">
<path value="AD.buildingNumberSuffix"/>
<definition
value="Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.buildingNumberSuffix"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.buildingNumberSuffix.partType">
<path value="AD.buildingNumberSuffix.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.buildingNumberSuffix.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="BNS"/>
</element>
<element id="AD.postBox">
<path value="AD.postBox"/>
<definition value="A numbered box located in a post station."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.postBox"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.postBox.partType">
<path value="AD.postBox.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.postBox.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="POB"/>
</element>
<element id="AD.precinct">
<path value="AD.precinct"/>
<definition value="A subsection of a municipality"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.precinct"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ADXP"/>
</type>
</element>
<element id="AD.precinct.partType">
<path value="AD.precinct.partType"/>
<representation value="xmlAttr"/>
<definition value="Specifies the type of the address part"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.precinct.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="PRE"/>
</element>
<element id="AD.other">
<path value="AD.other"/>
<representation value="xmlText"/>
<definition value="Textual representation of (part of) the address"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="AD.other"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="AD.useablePeriod">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype">
<valueCanonical
value="http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"/>
</extension>
<path value="AD.useablePeriod"/>
<representation value="typeAttr"/>
<label value="Useable Period"/>
<definition
value="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."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="AD.useablePeriod"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"/>
</type>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"/>
</type>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"/>
</type>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"/>
</type>
</element>
</snapshot>
<differential>
<element id="AD">
<path value="AD"/>
<constraint>
<key value="81-7296"/>
<severity value="error"/>
<human
value="**SHALL NOT** have mixed content except for white space (CONF:81-7296)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddressADUSFIELDED"/>
</constraint>
</element>
<element id="AD.use">
<path value="AD.use"/>
<short
value="If addr/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced"/>
<comment
value="SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet PostalAddressUse urn:oid:2.16.840.1.113883.1.11.10637 STATIC 2005-05-01 (CONF:81-7290)."/>
<max value="1"/>
<binding>
<strength value="required"/>
<valueSet
value="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.10637"/>
</binding>
</element>
<element id="AD.country">
<path value="AD.country"/>
<comment
value="SHOULD contain zero or one [0..1] country, which SHALL be selected from ValueSet Country urn:oid:2.16.840.1.113883.3.88.12.80.63 DYNAMIC (CONF:81-7295)."/>
<max value="1"/>
<binding>
<strength value="required"/>
<valueSet
value="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.63"/>
</binding>
</element>
<element id="AD.state">
<path value="AD.state"/>
<comment
value="SHOULD contain zero or one [0..1] state, which SHOULD be selected from ValueSet StateValueSet urn:oid:2.16.840.1.113883.3.88.12.80.1 DYNAMIC) (CONF:81-7293)."/>
<max value="1"/>
<constraint>
<key value="81-10024"/>
<severity value="error"/>
<human
value="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)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddressADUSFIELDED"/>
</constraint>
<binding>
<strength value="preferred"/>
<valueSet
value="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.1"/>
</binding>
</element>
<element id="AD.city">
<path value="AD.city"/>
<comment value="SHALL contain exactly one [1..1] city (CONF:81-7292)."/>
<min value="1"/>
<max value="1"/>
</element>
<element id="AD.postalCode">
<path value="AD.postalCode"/>
<comment
value="SHOULD contain zero or one [0..1] postalCode, which SHOULD be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 DYNAMIC (CONF:81-7294)."/>
<max value="1"/>
<constraint>
<key value="81-10025"/>
<severity value="error"/>
<human
value="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)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddressADUSFIELDED"/>
</constraint>
<binding>
<strength value="preferred"/>
<valueSet
value="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.80.2"/>
</binding>
</element>
<element id="AD.streetAddressLine">
<path value="AD.streetAddressLine"/>
<comment
value="SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291)."/>
<min value="1"/>
<max value="4"/>
</element>
</differential>
</StructureDefinition>
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change