Pharmaceutical Quality Submissions to Food & Drug Administration (PQ/CMC)
0.1.20 - Build CI
Pharmaceutical Quality Submissions to Food & Drug Administration (PQ/CMC)
0.1.20 - Build CI
Pharmaceutical Quality Submissions to Food & Drug Administration (PQ/CMC), published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.20 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/FHIR-us-pq-cmc/ and changes regularly. See the Directory of published versions
| Draft as of 2024-03-04 |
XML representation of the pq-cmc-address data type profile.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="pq-cmc-address"/>
<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-pq-cmc-address-definitions.html#Address">Address</a><a name="Address"> </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 (addr-state, addr-zip)">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">0</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="http://hl7.org/fhir/R5/datatypes.html#Address">Address</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">An address expressed using postal conventions (as opposed to GPS or other location definition formats)</span><br/><span style="font-weight:bold">addr-state: </span>If the country is USA, then the state and postal code exist<br/><span style="font-weight:bold">addr-zip: </span>If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers</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-pq-cmc-address-definitions.html#Address.line">line</a><a name="Address.line"> </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">1..2</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="http://hl7.org/fhir/R5/datatypes.html#string">string</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">Street name, number, direction & P.O. Box etc.</span></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-pq-cmc-address-definitions.html#Address.city">city</a><a name="Address.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"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">1</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 style="opacity: 0.5" href="http://hl7.org/fhir/R5/datatypes.html#string">string</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">Name of city, town etc.</span></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-pq-cmc-address-definitions.html#Address.state">state</a><a name="Address.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"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></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><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></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="http://hl7.org/fhir/R5/datatypes.html#string">string</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">Sub-unit of country (abbreviations ok)</span></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-pq-cmc-address-definitions.html#Address.postalCode">postalCode</a><a name="Address.postalCode"> </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="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">1</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 style="opacity: 0.5" href="http://hl7.org/fhir/R5/datatypes.html#string">string</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">Postal code for area</span></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_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: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-pq-cmc-address-definitions.html#Address.country">country</a><a name="Address.country"> </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="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">1</span></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="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Country can either be the ISO 3-letter country code or the full country name matching the code. The codes and full names are in the value set: GENC 3 Letter Codes</td></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/StructureDefinition/structuredefinition-wg">
<valueCode value="brr"/>
</extension>
<url
value="http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-cmc-address"/>
<version value="0.1.20"/>
<name value="PqAddress"/>
<status value="draft"/>
<date value="2024-03-04T02:24:01+00:00"/>
<publisher value="HL7 International / Biomedical Research and Regulation"/>
<contact>
<name value="HL7 International / Biomedical Research and Regulation"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/rcrim"/>
</telecom>
<telecom>
<system value="email"/>
<value value="brr@lists.HL7.org"/>
</telecom>
</contact>
<description
value="pq-specific Constraints on the Address datatype dealing with US addresses."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<fhirVersion value="5.0.0"/>
<mapping>
<identity value="v2"/>
<uri value="http://hl7.org/v2"/>
<name value="HL7 V2 Mapping"/>
</mapping>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<mapping>
<identity value="servd"/>
<uri value="http://www.omg.org/spec/ServD/1.0/"/>
<name value="ServD"/>
</mapping>
<mapping>
<identity value="vcard"/>
<uri value="http://w3.org/vcard"/>
<name value="vCard Mapping"/>
</mapping>
<kind value="complex-type"/>
<abstract value="false"/>
<type value="Address"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Address"/>
<derivation value="constraint"/>
<snapshot>
<element id="Address">
<path value="Address"/>
<short
value="An address expressed using postal conventions (as opposed to GPS or other location definition formats)"/>
<definition
value="An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address."/>
<comment
value="Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Address"/>
<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="addr-state"/>
<severity value="error"/>
<human
value="If the country is USA, then the state and postal code exist"/>
<expression
value="country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists())"/>
<source
value="http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-cmc-address"/>
</constraint>
<constraint>
<key value="addr-zip"/>
<severity value="error"/>
<human
value="If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers"/>
<expression
value="country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$')"/>
<source
value="http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-cmc-address"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a,AD"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="XAD"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="Address"/>
</mapping>
</element>
<element id="Address.id">
<path value="Address.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="id"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<condition value="ele-1"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Address.extension">
<path value="Address.extension"/>
<slicing>
<discriminator>
<type value="value"/>
<path value="url"/>
</discriminator>
<description value="Extensions are always sliced by (at least) url"/>
<rules value="open"/>
</slicing>
<short value="Additional content defined by implementations"/>
<definition
value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/>
<comment
value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</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="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Address.use">
<path value="Address.use"/>
<short
value="home | work | temp | old | billing - purpose of this address"/>
<definition value="The purpose of this address."/>
<comment
value="Applications can assume that an address is current unless it explicitly says that it is temporary or old."/>
<requirements
value="Allows an appropriate address to be chosen from a list of many."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Address.use"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<example>
<label value="General"/>
<valueCode value="home"/>
</example>
<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>
<isModifier value="true"/>
<isModifierReason
value="This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="AddressUse"/>
</extension>
<strength value="required"/>
<description value="The use of an address (home / work / etc.)."/>
<valueSet value="http://hl7.org/fhir/ValueSet/address-use|5.0.0"/>
</binding>
<mapping>
<identity value="v2"/>
<map value="XAD.7"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="unique(./use)"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./AddressPurpose"/>
</mapping>
</element>
<element id="Address.type">
<path value="Address.type"/>
<short value="postal | physical | both"/>
<definition
value="Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both."/>
<comment
value="The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Address.type"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<example>
<label value="General"/>
<valueCode value="both"/>
</example>
<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>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="AddressType"/>
</extension>
<strength value="required"/>
<description value="The type of an address (physical / postal)."/>
<valueSet value="http://hl7.org/fhir/ValueSet/address-type|5.0.0"/>
</binding>
<mapping>
<identity value="v2"/>
<map value="XAD.18"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="unique(./use)"/>
</mapping>
<mapping>
<identity value="vcard"/>
<map value="address type parameter"/>
</mapping>
</element>
<element id="Address.text">
<path value="Address.text"/>
<short value="Text representation of the address"/>
<definition
value="Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts."/>
<comment
value="Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part."/>
<requirements value="A renderable, unencoded form."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Address.text"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<example>
<label value="General"/>
<valueString value="137 Nowhere Street, Erewhon 9132"/>
</example>
<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>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="./formatted"/>
</mapping>
<mapping>
<identity value="vcard"/>
<map value="address label parameter"/>
</mapping>
</element>
<element id="Address.line">
<path value="Address.line"/>
<short value="Street name, number, direction & P.O. Box etc."/>
<definition
value="This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information."/>
<min value="1"/>
<max value="2"/>
<base>
<path value="Address.line"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="string"/>
</type>
<orderMeaning
value="The order in which lines should appear in an address label"/>
<example>
<label value="General"/>
<valueString value="137 Nowhere Street"/>
</example>
<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>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map
value="XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="AD.part[parttype = AL]"/>
</mapping>
<mapping>
<identity value="vcard"/>
<map value="street"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./StreetAddress (newline delimitted)"/>
</mapping>
</element>
<element id="Address.city">
<path value="Address.city"/>
<short value="Name of city, town etc."/>
<definition
value="The name of the city, town, suburb, village or other community or delivery center."/>
<alias value="Municpality"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Address.city"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<example>
<label value="General"/>
<valueString value="Erewhon"/>
</example>
<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>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="XAD.3"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="AD.part[parttype = CTY]"/>
</mapping>
<mapping>
<identity value="vcard"/>
<map value="locality"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./Jurisdiction"/>
</mapping>
</element>
<element id="Address.district">
<path value="Address.district"/>
<short value="District name (aka county)"/>
<definition value="The name of the administrative area (county)."/>
<comment
value="District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead."/>
<alias value="County"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Address.district"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<example>
<label value="General"/>
<valueString value="Madison"/>
</example>
<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>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="XAD.9"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="AD.part[parttype = CNT | CPA]"/>
</mapping>
</element>
<element id="Address.state">
<path value="Address.state"/>
<short value="Sub-unit of country (abbreviations ok)"/>
<definition
value="Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes)."/>
<alias value="Province"/>
<alias value="Territory"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Address.state"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</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>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="XAD.4"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="AD.part[parttype = STA]"/>
</mapping>
<mapping>
<identity value="vcard"/>
<map value="region"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./Region"/>
</mapping>
</element>
<element id="Address.postalCode">
<path value="Address.postalCode"/>
<short value="Postal code for area"/>
<definition
value="A postal code designating a region defined by the postal service."/>
<alias value="Zip"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Address.postalCode"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<example>
<label value="General"/>
<valueString value="9132"/>
</example>
<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>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="XAD.5"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="AD.part[parttype = ZIP]"/>
</mapping>
<mapping>
<identity value="vcard"/>
<map value="code"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./PostalIdentificationCode"/>
</mapping>
</element>
<element id="Address.country">
<path value="Address.country"/>
<short
value="Country can either be the ISO 3-letter country code or the full country name matching the code. The codes and full names are in the value set: GENC 3 Letter Codes"/>
<definition
value="Country - a nation as commonly understood or generally accepted."/>
<comment
value="ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Address.country"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</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>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="XAD.6"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="AD.part[parttype = CNT]"/>
</mapping>
<mapping>
<identity value="vcard"/>
<map value="country"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./Country"/>
</mapping>
</element>
<element id="Address.period">
<path value="Address.period"/>
<short value="Time period when address was/is in use"/>
<definition value="Time period when address was/is in use."/>
<requirements
value="Allows addresses to be placed in historical context."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Address.period"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Period"/>
</type>
<example>
<label value="General"/>
<valuePeriod>
<start value="2010-03-23"/>
<end value="2010-07-01"/>
</valuePeriod>
</example>
<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>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="XAD.12 / XAD.13 + XAD.14"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="./usablePeriod[type="IVL<TS>"]"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./StartDate and ./EndDate"/>
</mapping>
</element>
</snapshot>
<differential>
<element id="Address">
<path value="Address"/>
<constraint>
<key value="addr-state"/>
<severity value="error"/>
<human
value="If the country is USA, then the state and postal code exist"/>
<expression
value="country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists())"/>
<source
value="http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-cmc-address"/>
</constraint>
<constraint>
<key value="addr-zip"/>
<severity value="error"/>
<human
value="If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers"/>
<expression
value="country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$')"/>
<source
value="http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-cmc-address"/>
</constraint>
</element>
<element id="Address.line">
<path value="Address.line"/>
<min value="1"/>
<max value="2"/>
</element>
<element id="Address.city">
<path value="Address.city"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="Address.state">
<path value="Address.state"/>
<mustSupport value="true"/>
</element>
<element id="Address.postalCode">
<path value="Address.postalCode"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="Address.country">
<path value="Address.country"/>
<short
value="Country can either be the ISO 3-letter country code or the full country name matching the code. The codes and full names are in the value set: GENC 3 Letter Codes"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
</differential>
</StructureDefinition>
IG © 2021+ HL7 International / Biomedical Research and Regulation. Package hl7.fhir.us.pq-cmc-fda#0.1.20 based on FHIR 5.0.0. Generated 2024-03-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change