Release 5
FoundationThis page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Modeling and Methodology Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw Turtle (+ also see Turtle/RDF Format Specification)
StructureDefinition for Address
@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
# - resource -------------------------------------------------------------------
[] a fhir:StructureDefinition ;
fhir:id [ fhir:v "Address"] ;
fhir:text [
fhir:status [ fhir:v "generated" ]
] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
fhir:value [ fhir:v "normative" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ] ;
fhir:value [ fhir:v "4.0.0" ]
] ) ;
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/Address"], [ fhir:v "http://hl7.org/fhir/StructureDefinition/Address"] ;
fhir:version [ fhir:v "5.0.0"], [ fhir:v "5.0.0"] ;
fhir:name [ fhir:v "Address"], [ fhir:v "Address"] ;
fhir:status [ fhir:v "active"], [ fhir:v "active"] ;
fhir:experimental [ fhir:v "false"], [ fhir:v "false"] ;
fhir:date [ fhir:v "2023-03-26T15:21:02+11:00"], [ fhir:v "2023-03-26T15:21:02+11:00"] ;
fhir:publisher [ fhir:v "HL7 FHIR Standard"], [ fhir:v "HL7 FHIR Standard"] ;
fhir:contact ( [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://hl7.org/fhir" ]
] )
] [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://hl7.org/fhir" ]
] )
] ) ;
fhir:description [ fhir:v "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."], [ fhir:v "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."] ;
fhir:jurisdiction ( [
fhir:coding ( [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ]
] )
] [
fhir:coding ( [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ]
] )
] ) ;
fhir:purpose [ fhir:v "Need to be able to record postal addresses, along with notes about their use."], [ fhir:v "Need to be able to record postal addresses, along with notes about their use."] ;
fhir:fhirVersion [ fhir:v "5.0.0"] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:uri [ fhir:v "http://hl7.org/v2" ] ;
fhir:name [ fhir:v "HL7 V2 Mapping" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:uri [ fhir:v "http://hl7.org/v3" ] ;
fhir:name [ fhir:v "RIM Mapping" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:uri [ fhir:v "http://www.omg.org/spec/ServD/1.0/" ] ;
fhir:name [ fhir:v "ServD" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:uri [ fhir:v "http://w3.org/vcard" ] ;
fhir:name [ fhir:v "vCard Mapping" ]
] ) ;
fhir:kind [ fhir:v "complex-type"] ;
fhir:abstract [ fhir:v "false"] ;
fhir:type [ fhir:v "Address"] ;
fhir:baseDefinition [ fhir:v "http://hl7.org/fhir/StructureDefinition/DataType"] ;
fhir:derivation [ fhir:v "specialization"] ;
fhir:snapshot [
fhir:element ( [
fhir:id [ fhir:v "Address" ] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
fhir:value [ fhir:v "normative" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ] ;
fhir:value [ fhir:v "4.0.0" ]
] ) ;
fhir:path [ fhir:v "Address" ] ;
fhir:short [ fhir:v "An address expressed using postal conventions (as opposed to GPS or other location definition formats)" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "Address" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a,AD" ]
] [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "Address" ]
] )
] [
fhir:id [ fhir:v "Address.id" ] ;
fhir:path [ fhir:v "Address.id" ] ;
fhir:representation ( [ fhir:v "xmlAttr" ] ) ;
fhir:short [ fhir:v "Unique id for inter-element referencing" ] ;
fhir:definition [ fhir:v "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Element.id" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type" ] ;
fhir:value [ fhir:v "id" ]
] ) ;
fhir:code [ fhir:v "http://hl7.org/fhirpath/System.String" ]
] ) ;
fhir:condition ( [ fhir:v "ele-1" ] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "Address.extension" ] ;
fhir:path [ fhir:v "Address.extension" ] ;
fhir:slicing [
fhir:discriminator ( [
fhir:type [ fhir:v "value" ] ;
fhir:path [ fhir:v "url" ]
] ) ;
fhir:description [ fhir:v "Extensions are always sliced by (at least) url" ] ;
fhir:rules [ fhir:v "open" ]
] ;
fhir:short [ fhir:v "Additional content defined by implementations" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "Element.extension" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Extension" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] [
fhir:key [ fhir:v "ext-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "Must have either extensions or value[x], not both" ] ;
fhir:expression [ fhir:v "extension.exists() != value.exists()" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Extension" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "false" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "n/a" ]
] )
] [
fhir:id [ fhir:v "Address.use" ] ;
fhir:path [ fhir:v "Address.use" ] ;
fhir:short [ fhir:v "home | work | temp | old | billing - purpose of this address" ] ;
fhir:definition [ fhir:v "The purpose of this address." ] ;
fhir:comment [ fhir:v "Applications can assume that an address is current unless it explicitly says that it is temporary or old." ] ;
fhir:requirements [ fhir:v "Allows an appropriate address to be chosen from a list of many." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Address.use" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "home" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/binding-definition" ] ;
fhir:value [ fhir:v "The use of an address." ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "AddressUse" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "The use of an address (home / work / etc.)." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/address-use|5.0.0" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.7" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "unique(./use)" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./AddressPurpose" ]
] )
] [
fhir:id [ fhir:v "Address.type" ] ;
fhir:path [ fhir:v "Address.type" ] ;
fhir:short [ fhir:v "postal | physical | both" ] ;
fhir:definition [ fhir:v "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both." ] ;
fhir:comment [ fhir:v "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)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Address.type" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "both" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/binding-definition" ] ;
fhir:value [ fhir:v "The type of an address (physical / postal)." ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "AddressType" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "The type of an address (physical / postal)." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/address-type|5.0.0" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.18" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "unique(./use)" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "address type parameter" ]
] )
] [
fhir:id [ fhir:v "Address.text" ] ;
fhir:path [ fhir:v "Address.text" ] ;
fhir:short [ fhir:v "Text representation of the address" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "A renderable, unencoded form." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Address.text" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "137 Nowhere Street, Erewhon 9132" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./formatted" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "address label parameter" ]
] )
] [
fhir:id [ fhir:v "Address.line" ] ;
fhir:path [ fhir:v "Address.line" ] ;
fhir:short [ fhir:v "Street name, number, direction & P.O. Box etc." ] ;
fhir:definition [ fhir:v "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:base [
fhir:path [ fhir:v "Address.line" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:orderMeaning [ fhir:v "The order in which lines should appear in an address label" ] ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "137 Nowhere Street" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "AD.part[parttype = AL]" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "street" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./StreetAddress (newline delimitted)" ]
] )
] [
fhir:id [ fhir:v "Address.city" ] ;
fhir:path [ fhir:v "Address.city" ] ;
fhir:short [ fhir:v "Name of city, town etc." ] ;
fhir:definition [ fhir:v "The name of the city, town, suburb, village or other community or delivery center." ] ;
fhir:alias ( [ fhir:v "Municpality" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Address.city" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "Erewhon" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.3" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "AD.part[parttype = CTY]" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "locality" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./Jurisdiction" ]
] )
] [
fhir:id [ fhir:v "Address.district" ] ;
fhir:path [ fhir:v "Address.district" ] ;
fhir:short [ fhir:v "District name (aka county)" ] ;
fhir:definition [ fhir:v "The name of the administrative area (county)." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:alias ( [ fhir:v "County" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Address.district" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "Madison" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.9" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "AD.part[parttype = CNT | CPA]" ]
] )
] [
fhir:id [ fhir:v "Address.state" ] ;
fhir:path [ fhir:v "Address.state" ] ;
fhir:short [ fhir:v "Sub-unit of country (abbreviations ok)" ] ;
fhir:definition [ fhir:v "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)." ] ;
fhir:alias ( [ fhir:v "Province" ] [ fhir:v "Territory" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Address.state" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.4" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "AD.part[parttype = STA]" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "region" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./Region" ]
] )
] [
fhir:id [ fhir:v "Address.postalCode" ] ;
fhir:path [ fhir:v "Address.postalCode" ] ;
fhir:short [ fhir:v "Postal code for area" ] ;
fhir:definition [ fhir:v "A postal code designating a region defined by the postal service." ] ;
fhir:alias ( [ fhir:v "Zip" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Address.postalCode" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "9132" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.5" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "AD.part[parttype = ZIP]" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "code" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./PostalIdentificationCode" ]
] )
] [
fhir:id [ fhir:v "Address.country" ] ;
fhir:path [ fhir:v "Address.country" ] ;
fhir:short [ fhir:v "Country (e.g. may be ISO 3166 2 or 3 letter code)" ] ;
fhir:definition [ fhir:v "Country - a nation as commonly understood or generally accepted." ] ;
fhir:comment [ fhir:v "ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Address.country" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.6" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "AD.part[parttype = CNT]" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "country" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./Country" ]
] )
] [
fhir:id [ fhir:v "Address.period" ] ;
fhir:path [ fhir:v "Address.period" ] ;
fhir:short [ fhir:v "Time period when address was/is in use" ] ;
fhir:definition [ fhir:v "Time period when address was/is in use." ] ;
fhir:requirements [ fhir:v "Allows addresses to be placed in historical context." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:base [
fhir:path [ fhir:v "Address.period" ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ]
] ;
fhir:type ( [
fhir:code [ fhir:v "Period" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [
fhir:start [ fhir:v "2010-03-23" ] ;
fhir:end [ fhir:v "2010-07-01" ]
]
] ) ;
fhir:constraint ( [
fhir:key [ fhir:v "ele-1" ] ;
fhir:severity [ fhir:v "error" ] ;
fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ]
] ) ;
fhir:isModifier [ fhir:v "false" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.12 / XAD.13 + XAD.14" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./usablePeriod[type=\"IVL<TS>\"]" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./StartDate and ./EndDate" ]
] )
] )
] ;
fhir:differential [
fhir:element ( [
fhir:id [ fhir:v "Address" ] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
fhir:value [ fhir:v "normative" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ] ;
fhir:value [ fhir:v "4.0.0" ]
] ) ;
fhir:path [ fhir:v "Address" ] ;
fhir:short [ fhir:v "An address expressed using postal conventions (as opposed to GPS or other location definition formats)" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "AD" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "Address" ]
] )
] [
fhir:id [ fhir:v "Address.use" ] ;
fhir:path [ fhir:v "Address.use" ] ;
fhir:short [ fhir:v "home | work | temp | old | billing - purpose of this address" ] ;
fhir:definition [ fhir:v "The purpose of this address." ] ;
fhir:comment [ fhir:v "Applications can assume that an address is current unless it explicitly says that it is temporary or old." ] ;
fhir:requirements [ fhir:v "Allows an appropriate address to be chosen from a list of many." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "home" ]
] ) ;
fhir:isModifier [ fhir:v "true" ] ;
fhir:isModifierReason [ fhir:v "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one" ] ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/binding-definition" ] ;
fhir:value [ fhir:v "The use of an address." ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "AddressUse" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "The use of an address (home / work / etc.)." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/address-use|5.0.0" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.7" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "unique(./use)" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./AddressPurpose" ]
] )
] [
fhir:id [ fhir:v "Address.type" ] ;
fhir:path [ fhir:v "Address.type" ] ;
fhir:short [ fhir:v "postal | physical | both" ] ;
fhir:definition [ fhir:v "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both." ] ;
fhir:comment [ fhir:v "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)." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "code" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "both" ]
] ) ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:binding [
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/binding-definition" ] ;
fhir:value [ fhir:v "The type of an address (physical / postal)." ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ;
fhir:value [ fhir:v "AddressType" ]
] ) ;
fhir:strength [ fhir:v "required" ] ;
fhir:description [ fhir:v "The type of an address (physical / postal)." ] ;
fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/address-type|5.0.0" ]
] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.18" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "unique(./use)" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "address type parameter" ]
] )
] [
fhir:id [ fhir:v "Address.text" ] ;
fhir:path [ fhir:v "Address.text" ] ;
fhir:short [ fhir:v "Text representation of the address" ] ;
fhir:definition [ fhir:v "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." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:requirements [ fhir:v "A renderable, unencoded form." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "137 Nowhere Street, Erewhon 9132" ]
] ) ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./formatted" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "address label parameter" ]
] )
] [
fhir:id [ fhir:v "Address.line" ] ;
fhir:path [ fhir:v "Address.line" ] ;
fhir:short [ fhir:v "Street name, number, direction & P.O. Box etc." ] ;
fhir:definition [ fhir:v "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "*" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:orderMeaning [ fhir:v "The order in which lines should appear in an address label" ] ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "137 Nowhere Street" ]
] ) ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "AD.part[parttype = AL]" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "street" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./StreetAddress (newline delimitted)" ]
] )
] [
fhir:id [ fhir:v "Address.city" ] ;
fhir:path [ fhir:v "Address.city" ] ;
fhir:short [ fhir:v "Name of city, town etc." ] ;
fhir:definition [ fhir:v "The name of the city, town, suburb, village or other community or delivery center." ] ;
fhir:alias ( [ fhir:v "Municpality" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "Erewhon" ]
] ) ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.3" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "AD.part[parttype = CTY]" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "locality" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./Jurisdiction" ]
] )
] [
fhir:id [ fhir:v "Address.district" ] ;
fhir:path [ fhir:v "Address.district" ] ;
fhir:short [ fhir:v "District name (aka county)" ] ;
fhir:definition [ fhir:v "The name of the administrative area (county)." ] ;
fhir:comment [ fhir:v "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." ] ;
fhir:alias ( [ fhir:v "County" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "Madison" ]
] ) ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.9" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "AD.part[parttype = CNT | CPA]" ]
] )
] [
fhir:id [ fhir:v "Address.state" ] ;
fhir:path [ fhir:v "Address.state" ] ;
fhir:short [ fhir:v "Sub-unit of country (abbreviations ok)" ] ;
fhir:definition [ fhir:v "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)." ] ;
fhir:alias ( [ fhir:v "Province" ] [ fhir:v "Territory" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.4" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "AD.part[parttype = STA]" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "region" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./Region" ]
] )
] [
fhir:id [ fhir:v "Address.postalCode" ] ;
fhir:path [ fhir:v "Address.postalCode" ] ;
fhir:short [ fhir:v "Postal code for area" ] ;
fhir:definition [ fhir:v "A postal code designating a region defined by the postal service." ] ;
fhir:alias ( [ fhir:v "Zip" ] ) ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [ fhir:v "9132" ]
] ) ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.5" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "AD.part[parttype = ZIP]" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "code" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./PostalIdentificationCode" ]
] )
] [
fhir:id [ fhir:v "Address.country" ] ;
fhir:path [ fhir:v "Address.country" ] ;
fhir:short [ fhir:v "Country (e.g. may be ISO 3166 2 or 3 letter code)" ] ;
fhir:definition [ fhir:v "Country - a nation as commonly understood or generally accepted." ] ;
fhir:comment [ fhir:v "ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "string" ]
] ) ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.6" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "AD.part[parttype = CNT]" ]
] [
fhir:identity [ fhir:v "vcard" ] ;
fhir:map [ fhir:v "country" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./Country" ]
] )
] [
fhir:id [ fhir:v "Address.period" ] ;
fhir:path [ fhir:v "Address.period" ] ;
fhir:short [ fhir:v "Time period when address was/is in use" ] ;
fhir:definition [ fhir:v "Time period when address was/is in use." ] ;
fhir:requirements [ fhir:v "Allows addresses to be placed in historical context." ] ;
fhir:min [ fhir:v "0" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type ( [
fhir:code [ fhir:v "Period" ]
] ) ;
fhir:example ( [
fhir:label [ fhir:v "General" ] ;
fhir:value [
fhir:start [ fhir:v "2010-03-23" ] ;
fhir:end [ fhir:v "2010-07-01" ]
]
] ) ;
fhir:isSummary [ fhir:v "true" ] ;
fhir:mapping ( [
fhir:identity [ fhir:v "v2" ] ;
fhir:map [ fhir:v "XAD.12 / XAD.13 + XAD.14" ]
] [
fhir:identity [ fhir:v "rim" ] ;
fhir:map [ fhir:v "./usablePeriod[type=\"IVL<TS>\"]" ]
] [
fhir:identity [ fhir:v "servd" ] ;
fhir:map [ fhir:v "./StartDate and ./EndDate" ]
] )
] )
] .
# -------------------------------------------------------------------------------------
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:23+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change