{ "resourceType": "StructureDefinition", "id": "au-address", "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Address I0..*AddressAn address in Australia for use within an Australian healthcare context
inv-add-0: The address shall at least have text or a line
inv-add-1: If asserting no fixed address, the type shall be 'physical'
inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
inv-add-3: Postal code shall be 4 digits
\".\"\".\"\".\" extension 0..*ExtensionSlice: Unordered, Open by value:url
\".\"\".\"\".\" no-fixed-address 0..1booleanNo fixed address flag
URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address
\".\"\".\"\".\" city 0..1stringName of city, town, suburb, etc.
\".\"\".\"\".\" state 0..1stringAustralian state and territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
\".\"\".\"\".\" country 0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU

\"doco\" Documentation for this format
" }, "url": "http://hl7.org.au/fhir/StructureDefinition/au-address", "version": "1.1.1", "name": "AUBaseAddress", "title": "AU Base Address", "status": "active", "date": "2018-09-25T00:00:00+10:00", "publisher": "Health Level Seven Australia (Patient Administration WG)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org.au/fhir", "use": "work" } ] } ], "description": "This profile is provided for use in an Australian context where some constraint on content is desirable to guarantee the quality of an Australian address whilst still supporting other uses such as unstructured addresses.", "fhirVersion": "3.0.2", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "servd", "uri": "http://www.omg.org/spec/ServD/1.0/", "name": "ServD" }, { "identity": "vcard", "uri": "http://w3.org/vcard", "name": "vCard Mapping" } ], "kind": "complex-type", "abstract": false, "type": "Address", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Address", "derivation": "constraint", "snapshot": { "element": [ { "id": "Address", "path": "Address", "short": "An address in Australia for use within an Australian healthcare context", "definition": "An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats).", "comment": "Note: address is for postal addresses, not physical locations.", "min": 0, "max": "*", "base": { "path": "Address", "min": 0, "max": "*" }, "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" }, { "key": "inv-add-0", "severity": "error", "human": "The address shall at least have text or a line", "expression": "text.exists() or line.exists()" }, { "key": "inv-add-1", "severity": "error", "human": "If asserting no fixed address, the type shall be 'physical'", "expression": "extension.where(url='http://hl7.org.au/fhir/StructureDefinition/no-fixed-address' and value=true).exists() implies type='physical'" }, { "key": "inv-add-2", "severity": "error", "human": "If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'", "expression": "extension.where(url='http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')" }, { "key": "inv-add-3", "severity": "error", "human": "Postal code shall be 4 digits", "expression": "postalCode.exists() implies postalCode.matches('^[0-9]{4}$')" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD" }, { "identity": "rim", "map": "AD" }, { "identity": "servd", "map": "Address" } ] }, { "id": "Address.id", "path": "Address.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Address.extension", "path": "Address.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "Address.extension:noFixedAddress", "path": "Address.extension", "sliceName": "noFixedAddress", "short": "No fixed address flag", "definition": "No fixed address indicator.", "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": "http://hl7.org.au/fhir/StructureDefinition/no-fixed-address" } ] }, { "id": "Address.use", "path": "Address.use", "short": "home | work | temp | old - purpose of this address", "definition": "The purpose of this address.", "comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.", "requirements": "Allows an appropriate address to be chosen from a list of many.", "min": 0, "max": "1", "base": { "path": "Address.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "example": [ { "label": "General", "valueCode": "home" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressUse" } ], "strength": "required", "description": "The use of an address", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/address-use" } }, "mapping": [ { "identity": "v2", "map": "XAD.7" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./AddressPurpose" } ] }, { "id": "Address.type", "path": "Address.type", "short": "postal | physical | both", "definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.", "min": 0, "max": "1", "base": { "path": "Address.type", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "example": [ { "label": "General", "valueCode": "both" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressType" } ], "strength": "required", "description": "The type of an address (physical / postal)", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/address-type" } }, "mapping": [ { "identity": "v2", "map": "XAD.18" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "vcard", "map": "address type parameter" } ] }, { "id": "Address.text", "path": "Address.text", "short": "Text representation of the address", "definition": "A full text representation of the address.", "comment": "Can provide both a text representation and parts.", "requirements": "A renderable, unencoded form.", "min": 0, "max": "1", "base": { "path": "Address.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "137 Nowhere Street, Erewhon 9132" } ], "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" } ] }, { "id": "Address.line", "path": "Address.line", "short": "Street name, number, direction & P.O. Box etc.", "definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.", "requirements": "home | work | temp | old - purpose of this address.", "min": 0, "max": "*", "base": { "path": "Address.line", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "orderMeaning": "The order in which lines should appear in an address label", "example": [ { "label": "General", "valueString": "137 Nowhere Street" } ], "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)" } ] }, { "id": "Address.city", "path": "Address.city", "short": "Name of city, town, suburb, etc.", "definition": "The name of the city, town, village, suburb, or other community or delivery center.", "alias": [ "Municpality" ], "min": 0, "max": "1", "base": { "path": "Address.city", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "Erewhon" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "vcard", "map": "locality" }, { "identity": "servd", "map": "./Jurisdiction" } ] }, { "id": "Address.district", "path": "Address.district", "short": "District name (aka county)", "definition": "The name of the administrative area (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.", "alias": [ "County" ], "min": 0, "max": "1", "base": { "path": "Address.district", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "Madison" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.9" }, { "identity": "rim", "map": "AD.part[parttype = CNT | CPA]" } ] }, { "id": "Address.state", "path": "Address.state", "short": "Australian state and 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 (i.e. US 2 letter state codes).", "alias": [ "Province", "Territory" ], "min": 0, "max": "1", "base": { "path": "Address.state", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "binding": { "strength": "required", "valueSetReference": { "reference": "https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2" } }, "mapping": [ { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "vcard", "map": "region" }, { "identity": "servd", "map": "./Region" } ] }, { "id": "Address.postalCode", "path": "Address.postalCode", "short": "Postal code for area", "definition": "A postal code designating a region defined by the postal service.", "alias": [ "Zip" ], "min": 0, "max": "1", "base": { "path": "Address.postalCode", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "9132" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "vcard", "map": "code" }, { "identity": "servd", "map": "./PostalIdentificationCode" } ] }, { "id": "Address.country", "path": "Address.country", "short": "Australia as a 2 digit ISO 3166 code", "definition": "Fixed value if present otherwise assumed to be Australia in this context.", "comment": "ISO 3166 3 letter codes can be used in place of a full country name.", "min": 0, "max": "1", "base": { "path": "Address.country", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "fixedString": "AU", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "vcard", "map": "country" }, { "identity": "servd", "map": "./Country" } ] }, { "id": "Address.period", "path": "Address.period", "short": "Time period when address was/is in use", "definition": "Time period when address was/is in use.", "requirements": "Allows addresses to be placed in historical context.", "min": 0, "max": "1", "base": { "path": "Address.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "example": [ { "label": "General", "valuePeriod": { "start": "2010-03-23T00:00:00+11:00", "end": "2010-07-01T00:00:00+10:00" } } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.12 / XAD.13 + XAD.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] } ] }, "differential": { "element": [ { "id": "Address", "path": "Address", "short": "An address in Australia for use within an Australian healthcare context", "definition": "An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats).", "constraint": [ { "key": "inv-add-0", "severity": "error", "human": "The address shall at least have text or a line", "expression": "text.exists() or line.exists()" }, { "key": "inv-add-1", "severity": "error", "human": "If asserting no fixed address, the type shall be 'physical'", "expression": "extension.where(url='http://hl7.org.au/fhir/StructureDefinition/no-fixed-address' and value=true).exists() implies type='physical'" }, { "key": "inv-add-2", "severity": "error", "human": "If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'", "expression": "extension.where(url='http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')" }, { "key": "inv-add-3", "severity": "error", "human": "Postal code shall be 4 digits", "expression": "postalCode.exists() implies postalCode.matches('^[0-9]{4}$')" } ] }, { "id": "Address.extension", "path": "Address.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "Address.extension:noFixedAddress", "path": "Address.extension", "sliceName": "noFixedAddress", "definition": "No fixed address indicator.", "max": "1", "type": [ { "code": "Extension", "profile": "http://hl7.org.au/fhir/StructureDefinition/no-fixed-address" } ] }, { "id": "Address.city", "path": "Address.city", "short": "Name of city, town, suburb, etc.", "definition": "The name of the city, town, village, suburb, or other community or delivery center." }, { "id": "Address.state", "path": "Address.state", "short": "Australian state and territory", "binding": { "strength": "required", "valueSetUri": "https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2" } }, { "id": "Address.country", "path": "Address.country", "short": "Australia as a 2 digit ISO 3166 code", "definition": "Fixed value if present otherwise assumed to be Australia in this context.", "fixedString": "AU" } ] } }