{
  "description": "Australian realm Australian Address profile.",
  "_filename": "StructureDefinition-au-address.json",
  "package_name": "hl7.fhir.au.base",
  "date": "2017-05-05T05:09:53+10:00",
  "derivation": "constraint",
  "meta": {
    "lastUpdated": "2018-02-20T11:36:39.236+11:00"
  },
  "publisher": "Health Level Seven Australia (Patient Administration WG)",
  "fhirVersion": "3.0.1",
  "name": "BaseAustralianAddress",
  "mapping": [ {
    "uri": "http://hl7.org/v2",
    "name": "HL7 v2 Mapping",
    "identity": "v2"
  }, {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  }, {
    "uri": "http://www.omg.org/spec/ServD/1.0/",
    "name": "ServD",
    "identity": "servd"
  }, {
    "uri": "http://w3.org/vcard",
    "name": "vCard Mapping",
    "identity": "vcard"
  } ],
  "abstract": false,
  "type": "Address",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "Base Australian Address",
  "package_version": "0.9.3",
  "snapshot": {
    "element": [ {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "Element",
        "severity": "error",
        "expression": "hasValue() | (children().count() > id.count())"
      }, {
        "key": "inv-add-0",
        "human": "The address shall at least have text or a line",
        "severity": "error",
        "expression": "text.exists() or line.exists()"
      }, {
        "key": "inv-add-1",
        "human": "If not a fixed address, the type shall be 'physical'",
        "severity": "error",
        "expression": "extension.where(url='http://hl7.org.au/fhir/StructureDefinition/nofixedaddress' and value=true).exists() implies type='physical'"
      }, {
        "key": "inv-add-2",
        "human": "If not a fixed address, the address text shall begin with 'NO FIXED ADDRESS'",
        "severity": "error",
        "expression": "extension.where(url='http://hl7.org.au/fhir/StructureDefinition/nofixedaddress').exists() implies text.startsWith('NO FIXED ADDRESS')"
      } ],
      "path": "Address",
      "min": 0,
      "definition": "An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats).",
      "short": "An address in Australia for use within an Australian healthcare context",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      }, {
        "map": "XAD",
        "identity": "v2"
      }, {
        "map": "AD",
        "identity": "rim"
      }, {
        "map": "Address",
        "identity": "servd"
      } ],
      "max": "*",
      "id": "Address",
      "condition": [ "ele-1" ],
      "comment": "Note: address is for postal addresses, not physical locations.",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Address"
      }
    }, {
      "path": "Address.id",
      "min": 0,
      "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
      "short": "xml:id (or equivalent in JSON)",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "representation": [ "xmlAttr" ],
      "max": "1",
      "id": "Address.id",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Element.id"
      }
    }, {
      "path": "Address.extension",
      "min": 0,
      "definition": "An Extension",
      "short": "Extension",
      "slicing": {
        "rules": "open",
        "description": "Extensions are always sliced by (at least) url",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      },
      "type": [ {
        "code": "Extension"
      } ],
      "max": "*",
      "id": "Address.extension",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Element.extension"
      }
    }, {
      "path": "Address.extension",
      "min": 0,
      "definition": "No fixed address indicator.",
      "short": "Extension",
      "type": [ {
        "code": "Extension",
        "profile": "http://hl7.org.au/fhir/StructureDefinition/no-fixed-address"
      } ],
      "sliceName": "noFixedAddress",
      "max": "1",
      "id": "Address.extension:noFixedAddress",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Element.extension"
      }
    }, {
      "path": "Address.extension.id",
      "min": 0,
      "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
      "short": "xml:id (or equivalent in JSON)",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "representation": [ "xmlAttr" ],
      "max": "1",
      "id": "Address.extension:noFixedAddress.id",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Element.id"
      }
    }, {
      "path": "Address.extension.extension",
      "min": 0,
      "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
      "short": "Additional Content defined by implementations",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "slicing": {
        "rules": "open",
        "description": "Extensions are always sliced by (at least) url",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      },
      "type": [ {
        "code": "Extension"
      } ],
      "alias": [ "extensions", "user content" ],
      "max": "*",
      "id": "Address.extension:noFixedAddress.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.",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Element.extension"
      }
    }, {
      "path": "Address.extension.url",
      "min": 1,
      "definition": "Source of the definition for the extension code - a logical name or a URL.",
      "short": "identifies the meaning of the extension",
      "fixedUri": "http://hl7.org.au/fhir/StructureDefinition/no-fixed-address",
      "mapping": [ {
        "map": "N/A",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "uri"
      } ],
      "representation": [ "xmlAttr" ],
      "max": "1",
      "id": "Address.extension:noFixedAddress.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.",
      "base": {
        "max": "1",
        "min": 1,
        "path": "Extension.url"
      }
    }, {
      "path": "Address.extension.valueBoolean",
      "min": 1,
      "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
      "short": "Value of extension",
      "mapping": [ {
        "map": "N/A",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "boolean"
      } ],
      "max": "1",
      "id": "Address.extension:noFixedAddress.valueBoolean",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Extension.value[x]"
      },
      "fixedBoolean": true
    }, {
      "path": "Address.use",
      "requirements": "Allows an appropriate address to be chosen from a list of many.",
      "min": 0,
      "definition": "The purpose of this address.",
      "isModifier": true,
      "short": "home | work | temp | old - purpose of this address",
      "mapping": [ {
        "map": "XAD.7",
        "identity": "v2"
      }, {
        "map": "unique(./use)",
        "identity": "rim"
      }, {
        "map": "./AddressPurpose",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "code"
      } ],
      "binding": {
        "strength": "required",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString": "AddressUse"
        } ],
        "description": "The use of an address",
        "valueSetReference": {
          "reference": "http://hl7.org/fhir/ValueSet/address-use"
        }
      },
      "max": "1",
      "id": "Address.use",
      "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.",
      "example": [ {
        "label": "General",
        "valueCode": "home"
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "Address.use"
      },
      "isSummary": true
    }, {
      "path": "Address.type",
      "min": 0,
      "definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
      "short": "postal | physical | both",
      "mapping": [ {
        "map": "XAD.18",
        "identity": "v2"
      }, {
        "map": "unique(./use)",
        "identity": "rim"
      }, {
        "map": "address type parameter",
        "identity": "vcard"
      } ],
      "type": [ {
        "code": "code"
      } ],
      "binding": {
        "strength": "required",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString": "AddressType"
        } ],
        "description": "The type of an address (physical / postal)",
        "valueSetReference": {
          "reference": "http://hl7.org/fhir/ValueSet/address-type"
        }
      },
      "max": "1",
      "id": "Address.type",
      "example": [ {
        "label": "General",
        "valueCode": "both"
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "Address.type"
      },
      "isSummary": true
    }, {
      "path": "Address.text",
      "requirements": "A renderable, unencoded form.",
      "min": 0,
      "definition": "A full text representation of the address.",
      "short": "Text representation of the address",
      "mapping": [ {
        "map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6",
        "identity": "v2"
      }, {
        "map": "./formatted",
        "identity": "rim"
      }, {
        "map": "address label parameter",
        "identity": "vcard"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "max": "1",
      "id": "Address.text",
      "comment": "Can provide both a text representation and parts.",
      "example": [ {
        "label": "General",
        "valueString": "137 Nowhere Street, Erewhon 9132"
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "Address.text"
      },
      "isSummary": true
    }, {
      "path": "Address.line",
      "requirements": "home | work | temp | old - purpose of this address.",
      "min": 0,
      "definition": "This component contains the house number, apartment number, street name, street direction,  P.O. Box number, delivery hints, and similar address information.",
      "short": "Street name, number, direction & P.O. Box etc.",
      "mapping": [ {
        "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)",
        "identity": "v2"
      }, {
        "map": "AD.part[parttype = AL]",
        "identity": "rim"
      }, {
        "map": "street",
        "identity": "vcard"
      }, {
        "map": "./StreetAddress (newline delimitted)",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "max": "*",
      "id": "Address.line",
      "example": [ {
        "label": "General",
        "valueString": "137 Nowhere Street"
      } ],
      "orderMeaning": "The order in which lines should appear in an address label",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Address.line"
      },
      "isSummary": true
    }, {
      "path": "Address.city",
      "min": 0,
      "definition": "The name of the city, town, village, suburb, or other community or delivery center.",
      "short": "Name of city, town, suburb, etc.",
      "mapping": [ {
        "map": "XAD.3",
        "identity": "v2"
      }, {
        "map": "AD.part[parttype = CTY]",
        "identity": "rim"
      }, {
        "map": "locality",
        "identity": "vcard"
      }, {
        "map": "./Jurisdiction",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "alias": [ "Municpality" ],
      "max": "1",
      "id": "Address.city",
      "example": [ {
        "label": "General",
        "valueString": "Erewhon"
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "Address.city"
      },
      "isSummary": true
    }, {
      "path": "Address.district",
      "min": 0,
      "definition": "The name of the administrative area (county).",
      "short": "District name (aka county)",
      "mapping": [ {
        "map": "XAD.9",
        "identity": "v2"
      }, {
        "map": "AD.part[parttype = CNT | CPA]",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "alias": [ "County" ],
      "max": "1",
      "id": "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.",
      "example": [ {
        "label": "General",
        "valueString": "Madison"
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "Address.district"
      },
      "isSummary": true
    }, {
      "path": "Address.state",
      "min": 0,
      "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).",
      "short": "Australian state and territory",
      "mapping": [ {
        "map": "XAD.4",
        "identity": "v2"
      }, {
        "map": "AD.part[parttype = STA]",
        "identity": "rim"
      }, {
        "map": "region",
        "identity": "vcard"
      }, {
        "map": "./Region",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "binding": {
        "strength": "required",
        "valueSetReference": {
          "reference": "https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2"
        }
      },
      "alias": [ "Province", "Territory" ],
      "max": "1",
      "id": "Address.state",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Address.state"
      },
      "isSummary": true
    }, {
      "constraint": [ {
        "key": "inv-add-3",
        "human": "Postal code shall be 4 digits",
        "severity": "error",
        "expression": "(country='AU' and postalCode.exists()) implies postalCode.matches('^\\\\d{4}$')"
      } ],
      "path": "Address.postalCode",
      "min": 0,
      "definition": "A postal code designating a region defined by the postal service.",
      "short": "Postal code for area",
      "mapping": [ {
        "map": "XAD.5",
        "identity": "v2"
      }, {
        "map": "AD.part[parttype = ZIP]",
        "identity": "rim"
      }, {
        "map": "code",
        "identity": "vcard"
      }, {
        "map": "./PostalIdentificationCode",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "alias": [ "Zip" ],
      "max": "1",
      "id": "Address.postalCode",
      "example": [ {
        "label": "General",
        "valueString": "9132"
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "Address.postalCode"
      },
      "isSummary": true
    }, {
      "path": "Address.country",
      "min": 0,
      "definition": "fixed value if present otherwise assumed to be Australia in this context",
      "short": "Australia as a 2 digit ISO 3166 code",
      "mapping": [ {
        "map": "XAD.6",
        "identity": "v2"
      }, {
        "map": "AD.part[parttype = CNT]",
        "identity": "rim"
      }, {
        "map": "country",
        "identity": "vcard"
      }, {
        "map": "./Country",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "max": "1",
      "fixedString": "AU",
      "id": "Address.country",
      "comment": "ISO 3166 3 letter codes can be used in place of a full country name.",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Address.country"
      },
      "isSummary": true
    }, {
      "path": "Address.period",
      "requirements": "Allows addresses to be placed in historical context.",
      "min": 0,
      "definition": "Time period when address was/is in use.",
      "short": "Time period when address was/is in use",
      "mapping": [ {
        "map": "XAD.12 / XAD.13 + XAD.14",
        "identity": "v2"
      }, {
        "map": "./usablePeriod[type=\"IVL\"]",
        "identity": "rim"
      }, {
        "map": "./StartDate and ./EndDate",
        "identity": "servd"
      } ],
      "type": [ {
        "code": "Period"
      } ],
      "max": "1",
      "id": "Address.period",
      "example": [ {
        "label": "General",
        "valuePeriod": {
          "end": "2010-07-01T00:00:00+10:00",
          "start": "2010-03-23T00:00:00+11:00"
        }
      } ],
      "base": {
        "max": "1",
        "min": 0,
        "path": "Address.period"
      },
      "isSummary": true
    } ]
  },
  "status": "draft",
  "id": "ca69846d-a70f-46bf-abcb-bd019f0d79f4",
  "kind": "complex-type",
  "url": "http://hl7.org.au/fhir/StructureDefinition/au-address",
  "version": "0.1",
  "differential": {
    "element": [ {
      "id": "Address",
      "path": "Address",
      "short": "An address in Australia for use within an Australian healthcare context",
      "constraint": [ {
        "key": "inv-add-0",
        "human": "The address shall at least have text or a line",
        "severity": "error",
        "expression": "text.exists() or line.exists()"
      }, {
        "key": "inv-add-1",
        "human": "If not a fixed address, the type shall be 'physical'",
        "severity": "error",
        "expression": "extension.where(url='http://hl7.org.au/fhir/StructureDefinition/nofixedaddress' and value=true).exists() implies type='physical'"
      }, {
        "key": "inv-add-2",
        "human": "If not a fixed address, the address text shall begin with 'NO FIXED ADDRESS'",
        "severity": "error",
        "expression": "extension.where(url='http://hl7.org.au/fhir/StructureDefinition/nofixedaddress').exists() implies text.startsWith('NO FIXED ADDRESS')"
      } ],
      "definition": "An Australian address expressed using postal conventions (as opposed to GPS or other location definition formats)."
    }, {
      "id": "Address.extension",
      "path": "Address.extension",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      }
    }, {
      "id": "Address.extension:noFixedAddress",
      "max": "1",
      "path": "Address.extension",
      "type": [ {
        "code": "Extension",
        "profile": "http://hl7.org.au/fhir/StructureDefinition/no-fixed-address"
      } ],
      "sliceName": "noFixedAddress",
      "definition": "No fixed address indicator."
    }, {
      "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",
        "valueSetReference": {
          "reference": "https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2"
        }
      }
    }, {
      "id": "Address.postalCode",
      "path": "Address.postalCode",
      "constraint": [ {
        "key": "inv-add-3",
        "human": "Postal code shall be 4 digits",
        "severity": "error",
        "expression": "(country='AU' and postalCode.exists()) implies postalCode.matches('^\\\\d{4}$')"
      } ]
    }, {
      "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"
    } ]
  },
  "contact": [ {
    "telecom": [ {
      "use": "work",
      "value": "http://hl7.org.au/fhir",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Address"
}