{"abstract":false,"baseDefinition":"http://hl7.org/fhir/StructureDefinition/DataType","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/fiwg"}]}],"date":"2026-03-29T21:54:20+00:00","derivation":"specialization","description":"Address Type: 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.\nThe ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.","differential":{"element":[{"comment":"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).","definition":"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.\nThe ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.","id":"Address","mapping":[{"identity":"v2","map":"XAD"},{"identity":"rim","map":"AD"},{"identity":"servd","map":"Address"}],"max":"*","min":0,"path":"Address","short":"An address expressed using postal conventions (as opposed to GPS or other location definition formats)"},{"binding":{"description":"The use of an address (home / work / etc.).","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueMarkdown":"The use of an address."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AddressUse"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/address-use|6.0.0-ballot4"},"comment":"Applications can assume that an address is current unless it explicitly says that it is temporary or old.","definition":"The purpose of this address.","example":[{"label":"General","valueCode":"home"}],"id":"Address.use","isModifier":true,"isModifierReason":"This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one","isSummary":true,"mapping":[{"identity":"v2","map":"XAD.7"},{"identity":"rim","map":"unique(./use)"},{"identity":"servd","map":"./AddressPurpose"}],"max":"1","min":0,"path":"Address.use","requirements":"Allows an appropriate address to be chosen from a list of many.","short":"home | work | temp | old | billing - purpose of this address","type":[{"code":"code"}]},{"binding":{"description":"The type of an address (physical / postal).","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueMarkdown":"The type of an address (physical / postal)."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AddressType"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/address-type|6.0.0-ballot4"},"comment":"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). This element is relevant when there is potentially a collection of addresses and a need to differentiate the purpose of each. When this type is used on an element or extension where the 'purpose' of the address is implicit in the extension definition, 'use' will typically be omitted.","definition":"Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.","example":[{"label":"General","valueCode":"both"}],"id":"Address.type","isSummary":true,"mapping":[{"identity":"v2","map":"XAD.18"},{"identity":"rim","map":"unique(./use)"},{"identity":"vcard","map":"address type parameter"}],"max":"1","min":0,"path":"Address.type","short":"postal | physical | both","type":[{"code":"code"}]},{"comment":"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.","definition":"Specifies the entire address as it should be displayed e.g. on a postal label, using a newline delimiter for each line (e.g., \\n). This may be provided instead of or as well as the specific parts.","example":[{"label":"General","valueString":"137 Nowhere Street, Erewhon 9132"}],"id":"Address.text","isSummary":true,"mapping":[{"identity":"v2","map":"XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"},{"identity":"rim","map":"./formatted"},{"identity":"vcard","map":"address label parameter"}],"max":"1","min":0,"path":"Address.text","requirements":"A renderable, unencoded form.","short":"Text representation of the address","type":[{"code":"string"}]},{"definition":"This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.","example":[{"label":"General","valueString":"137 Nowhere Street"}],"id":"Address.line","isSummary":true,"mapping":[{"identity":"v2","map":"XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)"},{"identity":"rim","map":"AD.part[parttype = AL]"},{"identity":"vcard","map":"street"},{"identity":"servd","map":"./StreetAddress (newline delimitted)"}],"max":"*","min":0,"orderMeaning":"The order in which lines should appear in an address label","path":"Address.line","short":"Street name, number, direction & P.O. Box etc.","type":[{"code":"string"}]},{"alias":["Municpality"],"definition":"The name of the city, town, suburb, village or other community or delivery center.","example":[{"label":"General","valueString":"Erewhon"}],"id":"Address.city","isSummary":true,"mapping":[{"identity":"v2","map":"XAD.3"},{"identity":"rim","map":"AD.part[parttype = CTY]"},{"identity":"vcard","map":"locality"},{"identity":"servd","map":"./Jurisdiction"}],"max":"1","min":0,"path":"Address.city","short":"Name of city, town etc.","type":[{"code":"string"}]},{"alias":["County"],"comment":"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.","definition":"The name of the administrative area (county).","example":[{"label":"General","valueString":"Madison"}],"id":"Address.district","isSummary":true,"mapping":[{"identity":"v2","map":"XAD.9"},{"identity":"rim","map":"AD.part[parttype = CNT | CPA]"}],"max":"1","min":0,"path":"Address.district","short":"District name (aka county)","type":[{"code":"string"}]},{"alias":["Province","Territory"],"definition":"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).","id":"Address.state","isSummary":true,"mapping":[{"identity":"v2","map":"XAD.4"},{"identity":"rim","map":"AD.part[parttype = STA]"},{"identity":"vcard","map":"region"},{"identity":"servd","map":"./Region"}],"max":"1","min":0,"path":"Address.state","short":"Sub-unit of country (abbreviations ok)","type":[{"code":"string"}]},{"alias":["Zip"],"definition":"A postal code designating a region defined by the postal service.","example":[{"label":"General","valueString":"9132"}],"id":"Address.postalCode","isSummary":true,"mapping":[{"identity":"v2","map":"XAD.5"},{"identity":"rim","map":"AD.part[parttype = ZIP]"},{"identity":"vcard","map":"code"},{"identity":"servd","map":"./PostalIdentificationCode"}],"max":"1","min":0,"path":"Address.postalCode","short":"Postal code for area","type":[{"code":"string"}]},{"comment":"ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.","definition":"Country - a nation as commonly understood or generally accepted.","id":"Address.country","isSummary":true,"mapping":[{"identity":"v2","map":"XAD.6"},{"identity":"rim","map":"AD.part[parttype = CNT]"},{"identity":"vcard","map":"country"},{"identity":"servd","map":"./Country"}],"max":"1","min":0,"path":"Address.country","short":"Country (e.g. may be ISO 3166 2 or 3 letter code)","type":[{"code":"string"}]},{"definition":"Time period when address was/is in use.","example":[{"label":"General","valuePeriod":{"end":"2010-07-01","start":"2010-03-23"}}],"id":"Address.period","isSummary":true,"mapping":[{"identity":"v2","map":"XAD.12 / XAD.13 + XAD.14"},{"identity":"rim","map":"./usablePeriod[type=\"IVL\"]"},{"identity":"servd","map":"./StartDate and ./EndDate"}],"max":"1","min":0,"path":"Address.period","requirements":"Allows addresses to be placed in historical context.","short":"Time period when address was/is in use","type":[{"code":"Period"}]}]},"experimental":false,"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"normative"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"fhir"}],"fhirVersion":"6.0.0-ballot4","id":"Address","jurisdiction":[{"coding":[{"code":"001","display":"World","system":"http://unstats.un.org/unsd/methods/m49/m49.htm"}]}],"kind":"complex-type","mapping":[{"identity":"v2","name":"HL7 V2 Mapping","uri":"http://hl7.org/v2"},{"identity":"rim","name":"RIM Mapping","uri":"http://hl7.org/v3"},{"identity":"servd","name":"ServD","uri":"http://www.omg.org/spec/ServD/1.0/"},{"identity":"vcard","name":"vCard Mapping","uri":"http://w3.org/vcard"}],"name":"Address","publisher":"HL7 International / FHIR Infrastructure","purpose":"Need to be able to record postal addresses, along with notes about their use.","resourceType":"StructureDefinition","snapshot":{"element":[{"base":{"max":"*","min":0,"path":"Address"},"comment":"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).","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"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.\nThe ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.","id":"Address","isModifier":false,"mapping":[{"identity":"rim","map":"n/a,AD"},{"identity":"v2","map":"XAD"},{"identity":"servd","map":"Address"}],"max":"*","min":0,"path":"Address","short":"An address expressed using postal conventions (as opposed to GPS or other location definition formats)"},{"base":{"max":"1","min":0,"path":"Element.id"},"condition":["ele-1"],"definition":"Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","id":"Address.id","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"1","min":0,"path":"Address.id","representation":["xmlAttr"],"short":"Unique id for inter-element referencing","type":[{"code":"http://hl7.org/fhirpath/System.String","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type","valueUrl":"string"}]}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"Element.extension"},"comment":"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"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.","id":"Address.extension","isModifier":false,"isSummary":false,"mapping":[{"identity":"rim","map":"n/a"}],"max":"*","min":0,"path":"Address.extension","short":"Additional content defined by implementations","slicing":{"description":"Extensions are always sliced by (at least) url","discriminator":[{"path":"url","type":"value"}],"rules":"open"},"type":[{"code":"Extension"}]},{"base":{"max":"1","min":0,"path":"Address.use"},"binding":{"description":"The use of an address (home / work / etc.).","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueMarkdown":"The use of an address."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AddressUse"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/address-use|6.0.0-ballot4"},"comment":"Applications can assume that an address is current unless it explicitly says that it is temporary or old.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The purpose of this address.","example":[{"label":"General","valueCode":"home"}],"id":"Address.use","isModifier":true,"isModifierReason":"This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one","isSummary":true,"mapping":[{"identity":"v2","map":"XAD.7"},{"identity":"rim","map":"unique(./use)"},{"identity":"servd","map":"./AddressPurpose"}],"max":"1","min":0,"path":"Address.use","requirements":"Allows an appropriate address to be chosen from a list of many.","short":"home | work | temp | old | billing - purpose of this address","type":[{"code":"code"}]},{"base":{"max":"1","min":0,"path":"Address.type"},"binding":{"description":"The type of an address (physical / postal).","extension":[{"url":"http://hl7.org/fhir/tools/StructureDefinition/binding-definition","valueMarkdown":"The type of an address (physical / postal)."},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"AddressType"}],"strength":"required","valueSet":"http://hl7.org/fhir/ValueSet/address-type|6.0.0-ballot4"},"comment":"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). This element is relevant when there is potentially a collection of addresses and a need to differentiate the purpose of each. When this type is used on an element or extension where the 'purpose' of the address is implicit in the extension definition, 'use' will typically be omitted.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.","example":[{"label":"General","valueCode":"both"}],"id":"Address.type","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XAD.18"},{"identity":"rim","map":"unique(./use)"},{"identity":"vcard","map":"address type parameter"}],"max":"1","min":0,"path":"Address.type","short":"postal | physical | both","type":[{"code":"code"}]},{"base":{"max":"1","min":0,"path":"Address.text"},"comment":"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Specifies the entire address as it should be displayed e.g. on a postal label, using a newline delimiter for each line (e.g., \\n). This may be provided instead of or as well as the specific parts.","example":[{"label":"General","valueString":"137 Nowhere Street, Erewhon 9132"}],"id":"Address.text","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"},{"identity":"rim","map":"./formatted"},{"identity":"vcard","map":"address label parameter"}],"max":"1","min":0,"path":"Address.text","requirements":"A renderable, unencoded form.","short":"Text representation of the address","type":[{"code":"string"}]},{"base":{"max":"*","min":0,"path":"Address.line"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.","example":[{"label":"General","valueString":"137 Nowhere Street"}],"id":"Address.line","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)"},{"identity":"rim","map":"AD.part[parttype = AL]"},{"identity":"vcard","map":"street"},{"identity":"servd","map":"./StreetAddress (newline delimitted)"}],"max":"*","min":0,"orderMeaning":"The order in which lines should appear in an address label","path":"Address.line","short":"Street name, number, direction & P.O. Box etc.","type":[{"code":"string"}]},{"alias":["Municpality"],"base":{"max":"1","min":0,"path":"Address.city"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The name of the city, town, suburb, village or other community or delivery center.","example":[{"label":"General","valueString":"Erewhon"}],"id":"Address.city","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XAD.3"},{"identity":"rim","map":"AD.part[parttype = CTY]"},{"identity":"vcard","map":"locality"},{"identity":"servd","map":"./Jurisdiction"}],"max":"1","min":0,"path":"Address.city","short":"Name of city, town etc.","type":[{"code":"string"}]},{"alias":["County"],"base":{"max":"1","min":0,"path":"Address.district"},"comment":"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.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"The name of the administrative area (county).","example":[{"label":"General","valueString":"Madison"}],"id":"Address.district","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XAD.9"},{"identity":"rim","map":"AD.part[parttype = CNT | CPA]"}],"max":"1","min":0,"path":"Address.district","short":"District name (aka county)","type":[{"code":"string"}]},{"alias":["Province","Territory"],"base":{"max":"1","min":0,"path":"Address.state"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"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).","id":"Address.state","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XAD.4"},{"identity":"rim","map":"AD.part[parttype = STA]"},{"identity":"vcard","map":"region"},{"identity":"servd","map":"./Region"}],"max":"1","min":0,"path":"Address.state","short":"Sub-unit of country (abbreviations ok)","type":[{"code":"string"}]},{"alias":["Zip"],"base":{"max":"1","min":0,"path":"Address.postalCode"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"A postal code designating a region defined by the postal service.","example":[{"label":"General","valueString":"9132"}],"id":"Address.postalCode","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XAD.5"},{"identity":"rim","map":"AD.part[parttype = ZIP]"},{"identity":"vcard","map":"code"},{"identity":"servd","map":"./PostalIdentificationCode"}],"max":"1","min":0,"path":"Address.postalCode","short":"Postal code for area","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"Address.country"},"comment":"ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.","constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Country - a nation as commonly understood or generally accepted.","id":"Address.country","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XAD.6"},{"identity":"rim","map":"AD.part[parttype = CNT]"},{"identity":"vcard","map":"country"},{"identity":"servd","map":"./Country"}],"max":"1","min":0,"path":"Address.country","short":"Country (e.g. may be ISO 3166 2 or 3 letter code)","type":[{"code":"string"}]},{"base":{"max":"1","min":0,"path":"Address.period"},"constraint":[{"expression":"hasValue() or (children().count() > id.count())","human":"All FHIR elements must have a @value or children","key":"ele-1","severity":"error","source":"http://hl7.org/fhir/StructureDefinition/Element"}],"definition":"Time period when address was/is in use.","example":[{"label":"General","valuePeriod":{"end":"2010-07-01","start":"2010-03-23"}}],"id":"Address.period","isModifier":false,"isSummary":true,"mapping":[{"identity":"v2","map":"XAD.12 / XAD.13 + XAD.14"},{"identity":"rim","map":"./usablePeriod[type=\"IVL\"]"},{"identity":"servd","map":"./StartDate and ./EndDate"}],"max":"1","min":0,"path":"Address.period","requirements":"Allows addresses to be placed in historical context.","short":"Time period when address was/is in use","type":[{"code":"Period"}]}]},"status":"active","text":{"div":"
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" AddressΣNElementAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

Elements defined in Ancestors: id, extension
\".\"\".\"\".\" use?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (Required)
\".\"\".\"\".\" typeΣ0..1codepostal | physical | both
Binding: AddressType (Required)
\".\"\".\"\".\" textΣ0..1stringText representation of the address
\".\"\".\"\".\" lineΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
\".\"\".\"\".\" cityΣ0..1stringName of city, town etc.
\".\"\".\"\".\" districtΣ0..1stringDistrict name (aka county)
\".\"\".\"\".\" stateΣ0..1stringSub-unit of country (abbreviations ok)
\".\"\".\"\".\" postalCodeΣ0..1stringPostal code for area
\".\"\".\"\".\" countryΣ0..1stringCountry (e.g. may be ISO 3166 2 or 3 letter code)
\".\"\".\"\".\" periodΣ0..1PeriodTime period when address was/is in use

\"doco\" Documentation for this format
","status":"generated"},"type":"Address","url":"http://hl7.org/fhir/StructureDefinition/Address","version":"6.0.0-ballot4"}