Address.profile.json

StructureDefinition for Address

{
  "resourceType": "StructureDefinition",
  "id": "Address",
  "meta": {
    "lastUpdated": "2015-03-27T00:13:00.999+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/Address",
  "name": "Address",
  "publisher": "HL7 FHIR Standard",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "description": "Base StructureDefinition for Address Resource",
  "requirements": "Need to be able to record postal addresses, along with notes about their use.",
  "status": "draft",
  "date": "2015-03-27T00:13:00+11:00",
  "mapping": [
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    },
    {
      "identity": "servd",
      "uri": "http://www.omg.org/spec/ServD/1.0/",
      "name": "ServD"
    },
    {
      "identity": "vcard",
      "uri": "http://w3.org/vcard",
      "name": "vCard"
    }
  ],
  "type": "type",
  "abstract": false,
  "base": "http://hl7.org/fhir/StructureDefinition/Element",
  "snapshot": {
    "element": [
      {
        "path": "Address",
        "short": "A postal address",
        "definition": "There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world.",
        "comments": "Note: address is for postal addresses, not physical locations.",
        "requirements": "Need to be able to record postal addresses, along with notes about their use.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Address"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "XAD"
          },
          {
            "identity": "rim",
            "map": "AD"
          },
          {
            "identity": "servd",
            "map": "Address"
          }
        ]
      },
      {
        "path": "Address.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "Address.extension",
        "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. 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.",
        "comments": "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": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "Address.use",
        "short": "home | work | temp | old - purpose of this address",
        "definition": "The purpose of this address.",
        "comments": "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",
        "type": [
          {
            "code": "code"
          }
        ],
        "exampleCode": "home",
        "isModifier": true,
        "binding": {
          "name": "AddressUse",
          "strength": "required",
          "description": "The use of an address",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/address-use"
          }
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "XAD.7"
          },
          {
            "identity": "rim",
            "map": "unique(./use)"
          },
          {
            "identity": "servd",
            "map": "./AddressPurpose"
          }
        ]
      },
      {
        "path": "Address.text",
        "short": "Text representation of the address",
        "definition": "A full text representation of the address.",
        "comments": "Can provide both a text representation and parts.",
        "requirements": "A renderable, unencoded form.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "exampleString": "137 Nowhere Street, Erewhon 9132",
        "mapping": [
          {
            "identity": "v2",
            "map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"
          },
          {
            "identity": "rim",
            "map": "./formatted"
          }
        ]
      },
      {
        "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, \nP.O. Box number, delivery hints, and similar address information.",
        "requirements": "home | work | temp | old - purpose of this address.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ],
        "exampleString": "137 Nowhere Street",
        "mapping": [
          {
            "identity": "vcard",
            "map": "street address"
          },
          {
            "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": "servd",
            "map": "./StreetAddress (newline delimitted)"
          }
        ]
      },
      {
        "path": "Address.city",
        "short": "Name of city, town etc.",
        "definition": "The name of the city, town, village or other community or delivery center.",
        "alias": [
          "Muncipality"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "exampleString": "Erewhon",
        "mapping": [
          {
            "identity": "vcard",
            "map": "locality"
          },
          {
            "identity": "v2",
            "map": "XAD.3"
          },
          {
            "identity": "rim",
            "map": "AD.part[parttype = CTY]"
          },
          {
            "identity": "servd",
            "map": "./Jurisdiction"
          }
        ]
      },
      {
        "path": "Address.state",
        "short": "Sub-unit of country (abreviations ok)",
        "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",
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "vcard",
            "map": "region"
          },
          {
            "identity": "v2",
            "map": "XAD.4"
          },
          {
            "identity": "rim",
            "map": "AD.part[parttype = STA]"
          },
          {
            "identity": "servd",
            "map": "./Region"
          }
        ]
      },
      {
        "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",
        "type": [
          {
            "code": "string"
          }
        ],
        "exampleString": "9132",
        "mapping": [
          {
            "identity": "vcard",
            "map": "postal code"
          },
          {
            "identity": "v2",
            "map": "XAD.5"
          },
          {
            "identity": "rim",
            "map": "AD.part[parttype = ZIP]"
          },
          {
            "identity": "servd",
            "map": "./PostalIdentificationCode"
          }
        ]
      },
      {
        "path": "Address.country",
        "short": "Country (can be ISO 3166 3 letter code)",
        "definition": "Country - a nation as commonly understood or generally accepted.",
        "comments": "ISO 3166 3 letter codes can be used in place of a full country name.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "vcard",
            "map": "country name"
          },
          {
            "identity": "v2",
            "map": "XAD.6"
          },
          {
            "identity": "rim",
            "map": "AD.part[parttype = CNT]"
          },
          {
            "identity": "servd",
            "map": "./Country"
          }
        ]
      },
      {
        "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",
        "type": [
          {
            "code": "Period"
          }
        ],
        "examplePeriod": {
          "start": "2010-03-23",
          "end": "2010-07-01"
        },
        "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": [
      {
        "path": "Address",
        "short": "A postal address",
        "definition": "There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world.",
        "comments": "Note: address is for postal addresses, not physical locations.",
        "requirements": "Need to be able to record postal addresses, along with notes about their use.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Element"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "XAD"
          },
          {
            "identity": "rim",
            "map": "AD"
          },
          {
            "identity": "servd",
            "map": "Address"
          }
        ]
      },
      {
        "path": "Address.use",
        "short": "home | work | temp | old - purpose of this address",
        "definition": "The purpose of this address.",
        "comments": "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",
        "type": [
          {
            "code": "code"
          }
        ],
        "exampleCode": "home",
        "isModifier": true,
        "binding": {
          "name": "AddressUse",
          "strength": "required",
          "description": "The use of an address",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/address-use"
          }
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "XAD.7"
          },
          {
            "identity": "rim",
            "map": "unique(./use)"
          },
          {
            "identity": "servd",
            "map": "./AddressPurpose"
          }
        ]
      },
      {
        "path": "Address.text",
        "short": "Text representation of the address",
        "definition": "A full text representation of the address.",
        "comments": "Can provide both a text representation and parts.",
        "requirements": "A renderable, unencoded form.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "exampleString": "137 Nowhere Street, Erewhon 9132",
        "mapping": [
          {
            "identity": "v2",
            "map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"
          },
          {
            "identity": "rim",
            "map": "./formatted"
          }
        ]
      },
      {
        "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, \nP.O. Box number, delivery hints, and similar address information.",
        "requirements": "home | work | temp | old - purpose of this address.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ],
        "exampleString": "137 Nowhere Street",
        "mapping": [
          {
            "identity": "vcard",
            "map": "street address"
          },
          {
            "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": "servd",
            "map": "./StreetAddress (newline delimitted)"
          }
        ]
      },
      {
        "path": "Address.city",
        "short": "Name of city, town etc.",
        "definition": "The name of the city, town, village or other community or delivery center.",
        "alias": [
          "Muncipality"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "exampleString": "Erewhon",
        "mapping": [
          {
            "identity": "vcard",
            "map": "locality"
          },
          {
            "identity": "v2",
            "map": "XAD.3"
          },
          {
            "identity": "rim",
            "map": "AD.part[parttype = CTY]"
          },
          {
            "identity": "servd",
            "map": "./Jurisdiction"
          }
        ]
      },
      {
        "path": "Address.state",
        "short": "Sub-unit of country (abreviations ok)",
        "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",
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "vcard",
            "map": "region"
          },
          {
            "identity": "v2",
            "map": "XAD.4"
          },
          {
            "identity": "rim",
            "map": "AD.part[parttype = STA]"
          },
          {
            "identity": "servd",
            "map": "./Region"
          }
        ]
      },
      {
        "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",
        "type": [
          {
            "code": "string"
          }
        ],
        "exampleString": "9132",
        "mapping": [
          {
            "identity": "vcard",
            "map": "postal code"
          },
          {
            "identity": "v2",
            "map": "XAD.5"
          },
          {
            "identity": "rim",
            "map": "AD.part[parttype = ZIP]"
          },
          {
            "identity": "servd",
            "map": "./PostalIdentificationCode"
          }
        ]
      },
      {
        "path": "Address.country",
        "short": "Country (can be ISO 3166 3 letter code)",
        "definition": "Country - a nation as commonly understood or generally accepted.",
        "comments": "ISO 3166 3 letter codes can be used in place of a full country name.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "vcard",
            "map": "country name"
          },
          {
            "identity": "v2",
            "map": "XAD.6"
          },
          {
            "identity": "rim",
            "map": "AD.part[parttype = CNT]"
          },
          {
            "identity": "servd",
            "map": "./Country"
          }
        ]
      },
      {
        "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",
        "type": [
          {
            "code": "Period"
          }
        ],
        "examplePeriod": {
          "start": "2010-03-23",
          "end": "2010-07-01"
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "XAD.12 / XAD.13 + XAD.14"
          },
          {
            "identity": "rim",
            "map": "./usablePeriod[type=\"IVL<TS>\"]"
          },
          {
            "identity": "servd",
            "map": "./StartDate and ./EndDate"
          }
        ]
      }
    ]
  }
}