Package | at.unofficial.au.base |
Type | StructureDefinition |
Id | au-address |
FHIR Version | R4 |
Source | http://hl7.org.au/fhir/https://simplifier.net/resolve?scope=at.unofficial.au.base@2.2.0-ballot2&canonical=http://hl7.org.au/fhir/StructureDefinition/au-address |
URL | http://hl7.org.au/fhir/StructureDefinition/au-address |
Version | 2.2.0 |
Status | active |
Date | 2021-07-05 |
Name | AustralianAddress |
Title | Australian Address |
Realm | au |
Authority | hl7 |
Description | This profile defines an address structure that localises core concepts, including identifiers and terminology, for use in an Australian context, to specifically represent an Australian (location) address. |
Copyright | HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
Type | Address |
Kind | complex-type |
StructureDefinition | |
SHCPatient | Smart Health Checks Patient |
au-location | AU Base Location |
au-organization | AU Base Organization |
au-patient | AU Base Patient |
au-practitioner | AU Base Practitioner |
au-relatedperson | AU Base RelatedPerson |
au-location | AU Base Location |
au-organization | AU Base Organisation |
au-patient | AU Base Patient |
au-practitioner | AU Base Practitioner |
au-relatedperson | AU Base Related Person |
StructureDefinition | |
address-identifier | Address Identifier |
au-deliverypointidentifier | AU Delivery Point Identifier |
au-gnafidentifier | AU G-NAF Identifier |
no-fixed-address | No Fixed Address |
address-identifier | Address Identifier |
au-deliverypointidentifier | Delivery Point Identifier |
au-gnafidentifier | AU G-NAF Identifier |
no-fixed-address | No Fixed Address |
ValueSet | |
australian-states-territories-2 | Australian States and Territories |
Note: links and images are rebased to the (stated) source
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Address | An 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' |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..* | Identifier | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier | |
![]() ![]() ![]() ![]() | 1..1 | Identifier, DeliveryPointIdentifier, AUGNAFIdentifier | An identifier intended for computation | |
![]() ![]() ![]() | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address | |
![]() ![]() ![]() | 0..1 | string | Name of city, town or suburb | |
![]() ![]() ![]() | 0..1 | string | Australian state or territory Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required) | |
![]() ![]() ![]() | I | 0..1 | string | Postal code for area inv-add-3: Postal code shall be 4 digits |
![]() ![]() ![]() | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU | |
![]() |
{ "resourceType": "StructureDefinition", "id": "au-address", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "url": "http://hl7.org.au/fhir/StructureDefinition/au-address", "version": "2.2.0", "name": "AustralianAddress", "title": "Australian Address", "status": "active", "date": "2021-07-05", "publisher": "Health Level Seven Australia (Patient Administration WG)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.com.au", "use": "work" } ] } ], "description": "This profile defines an address structure that localises core concepts, including identifiers and terminology, for use in an Australian context, to specifically represent an Australian (location) address.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "AU" } ] } ], "copyright": "HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.", "fhirVersion": "4.0.1", "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 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](http://hl7.org/fhir/R4/location.html#) resource).", "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() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "inv-add-0", "severity": "error", "human": "The address shall at least have text or a line", "expression": "text.exists() or line.exists()", "source": "http://hl7.org.au/fhir/StructureDefinition/au-address" }, { "key": "inv-add-1", "severity": "error", "human": "If asserting no fixed address, the type shall be 'physical'", "expression": "extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'", "source": "http://hl7.org.au/fhir/StructureDefinition/au-address" }, { "key": "inv-add-2", "severity": "error", "human": "If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'", "expression": "extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')", "source": "http://hl7.org.au/fhir/StructureDefinition/au-address" } ], "isModifier": false, "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": "Unique id for inter-element referencing", "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": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false }, { "id": "Address.extension:identifier", "path": "Address.extension", "sliceName": "identifier", "short": "Identifier for the address", "definition": "A unique identifier associated with a location address and may be used to look up an address, validate an address, or link to other data relating to an address.", "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org.au/fhir/StructureDefinition/address-identifier" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false }, { "id": "Address.extension:identifier.id", "path": "Address.extension.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "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": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Address.extension:identifier.extension", "path": "Address.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "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 manageable, 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": "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": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Address.extension:identifier.url", "path": "Address.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "fixedUri": "http://hl7.org.au/fhir/StructureDefinition/address-identifier", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Address.extension:identifier.value[x]", "path": "Address.extension.value[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "closed" }, "short": "Address identifier", "definition": "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.", "min": 1, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "Identifier" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" } ] }, { "id": "Address.extension:identifier.value[x]:valueIdentifier", "path": "Address.extension.value[x]", "sliceName": "valueIdentifier", "short": "An identifier intended for computation", "definition": "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.", "min": 1, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "Identifier", "profile": [ "http://hl7.org/fhir/StructureDefinition/Identifier", "http://hl7.org.au/fhir/StructureDefinition/au-deliverypointidentifier", "http://hl7.org.au/fhir/StructureDefinition/au-gnafidentifier" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" } ] }, { "id": "Address.extension:noFixedAddress", "path": "Address.extension", "sliceName": "noFixedAddress", "short": "No fixed address indicator", "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" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false }, { "id": "Address.use", "path": "Address.use", "short": "home | work | temp | old | billing - purpose of this address", "definition": "The purpose of this address.", "comment": "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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "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, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressUse" } ], "strength": "required", "description": "The use of an address.", "valueSet": "http://hl7.org/fhir/ValueSet/address-use|4.0.1" }, "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.", "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](http://hl7.org/fhir/R4/location.html#) resource).", "min": 0, "max": "1", "base": { "path": "Address.type", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "example": [ { "label": "General", "valueCode": "both" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressType" } ], "strength": "required", "description": "The type of an address (physical / postal).", "valueSet": "http://hl7.org/fhir/ValueSet/address-type|4.0.1" }, "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": "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": "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": "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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "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" } ] }, { "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.", "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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "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)" } ] }, { "id": "Address.city", "path": "Address.city", "short": "Name of city, town or suburb", "definition": "The name of the city, town, suburb, village 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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "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" } ] }, { "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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "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 or 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).", "alias": [ "Province", "Territory" ], "min": 0, "max": "1", "base": { "path": "Address.state", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "strength": "required", "valueSet": "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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "inv-add-3", "severity": "error", "human": "Postal code shall be 4 digits", "expression": "matches('^[0-9]{4}[%content%]#39;)", "source": "http://hl7.org.au/fhir/StructureDefinition/au-address" } ], "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" } ] }, { "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 human readable country name.", "min": 0, "max": "1", "base": { "path": "Address.country", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "fixedString": "AU", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "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" } ] }, { "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-23", "end": "2010-07-01" } } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.12 / XAD.13 + XAD.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "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()", "source": "http://hl7.org.au/fhir/StructureDefinition/au-address" }, { "key": "inv-add-1", "severity": "error", "human": "If asserting no fixed address, the type shall be 'physical'", "expression": "extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical'", "source": "http://hl7.org.au/fhir/StructureDefinition/au-address" }, { "key": "inv-add-2", "severity": "error", "human": "If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'", "expression": "extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS')", "source": "http://hl7.org.au/fhir/StructureDefinition/au-address" } ] }, { "id": "Address.extension", "path": "Address.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "Address.extension:identifier", "path": "Address.extension", "sliceName": "identifier", "type": [ { "code": "Extension", "profile": [ "http://hl7.org.au/fhir/StructureDefinition/address-identifier" ] } ] }, { "id": "Address.extension:identifier.valueIdentifier:valueIdentifier", "path": "Address.extension.valueIdentifier", "sliceName": "valueIdentifier", "type": [ { "code": "Identifier", "profile": [ "http://hl7.org/fhir/StructureDefinition/Identifier", "http://hl7.org.au/fhir/StructureDefinition/au-deliverypointidentifier", "http://hl7.org.au/fhir/StructureDefinition/au-gnafidentifier" ] } ] }, { "id": "Address.extension:noFixedAddress", "path": "Address.extension", "sliceName": "noFixedAddress", "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 or suburb" }, { "id": "Address.state", "path": "Address.state", "short": "Australian state or territory", "binding": { "strength": "required", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2" } }, { "id": "Address.postalCode", "path": "Address.postalCode", "constraint": [ { "key": "inv-add-3", "severity": "error", "human": "Postal code shall be 4 digits", "expression": "matches('^[0-9]{4}[%content%]#39;)", "source": "http://hl7.org.au/fhir/StructureDefinition/au-address" } ] }, { "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" } ] } }