FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.xver-r2.r4b
Resource TypeCodeSystem
IdCodeSystem-v3-AddressPartType.json
FHIR VersionR4B
Sourcehttp://hl7.org/fhir/xver-r2.r4b/0.0.1-snapshot-2/CodeSystem-v3-AddressPartType.html
URLhttp://hl7.org/fhir/v3/AddressPartType
Version1.0.2
Statusdraft
Date2025-09-13T15:10:02-04:00
Namev3-AddressPartType
Realmuv
Authorityhl7
Contentcomplete

Resources that use this resource

ValueSet
R2-v3-AddressPartType-for-R4BCross-version VS for R2.v3 Code System AddressPartType for use in FHIR R4B
R3-v3-AddressPartType-for-R4BCross-version VS for R3.v3 Code System AddressPartType for use in FHIR R4B
R2-v3-AddressPartType-for-R5Cross-version VS for R2.v3 Code System AddressPartType for use in FHIR R5
R3-v3-AddressPartType-for-R5Cross-version VS for R3.v3 Code System AddressPartType for use in FHIR R5

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CodeSystem v3-AddressPartType

Properties

This code system defines the following properties for its concepts

NameCodeURIType
statusstatushttp://hl7.org/fhir/concept-properties#statuscode
Inactiveinactivehttp://hl7.org/fhir/concept-properties#inactiveboolean
effectiveDateeffectiveDatehttp://hl7.org/fhir/concept-properties#effectiveDatedateTime
deprecationDatedeprecationDatehttp://hl7.org/fhir/concept-properties#deprecationDatedateTime
retirementDateretirementDatehttp://hl7.org/fhir/concept-properties#retirementDatedateTime
Not SelectablenotSelectablehttp://hl7.org/fhir/concept-properties#notSelectableboolean
Parentparenthttp://hl7.org/fhir/concept-properties#parentcode
Childchildhttp://hl7.org/fhir/concept-properties#childcode
partOfpartOfhttp://hl7.org/fhir/concept-properties#partOfcode
synonymsynonymhttp://hl7.org/fhir/concept-properties#synonymcode
commentcommenthttp://hl7.org/fhir/concept-properties#commentstring
itemWeightitemWeighthttp://hl7.org/fhir/concept-properties#itemWeightdecimal

Concepts

This case-sensitive code system http://hl7.org/fhir/v3/AddressPartType defines the following codes in an undefined hierarchy:

LvlCodeDisplayDefinitionNot Selectable
1ADL additional locatorThis can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g. "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g. Dutch "t.o." means "opposite to" for house boats located across the street facing houses).false
1AL address lineDescription: An address line is for either an additional locator, a delivery address or a street address.false
2  DAL delivery address lineA delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc. An address generally has only a delivery address line or a street address line, but not both.false
2  SAL street address lineDescription: A street address line is frequently used instead of breaking out build number, street name, street type, etc. An address generally has only a delivery address line or a street address line, but not both.false
1BNN building number numericThe numeric portion of a building numberfalse
1BNR building numberThe number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.false
1BNS building number suffixAny alphabetic character, fraction or other text that may appear after the numeric portion of a building numberfalse
1CAR care ofThe name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipientfalse
1CEN census tractA geographic sub-unit delineated for demographic purposes.false
1CNT countryCountryfalse
1CPA county or parishA sub-unit of a state or province. (49 of the United States of America use the term "county;" Louisiana uses the term "parish".)false
1CTY municipalityThe name of the city, town, village, or other community or delivery centerfalse
1DEL delimiterDelimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.false
1DINST delivery installation typeIndicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc.false
1DINSTA delivery installation areaThe location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route.false
1DINSTQ delivery installation qualifierA number, letter or name identifying a delivery installation; e.g. for Station A, the delivery installation qualifier would be 'A'.false
1DIR directionDirection (e.g. N, S, W, E)false
1DMOD delivery modeIndicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.false
1DMODID delivery mode identifierRepresents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number).false
1DPID delivery point identifierA value that uniquely identifies the postal address.false
1INT intersectionDescription:An intersection denotes that the actual address is located AT or CLOSE TO the intersection OF two or more streets.false
1POB post boxA numbered box located in a post station.false
1PRE precinctA subsection of a municipalityfalse
1STA state or provinceA sub-unit of a country with limited sovereignty in a federally organized country.false
1STB street name baseThe base name of a roadway or artery recognized by a municipality (excluding street type and direction)false
1STR street namestreet namefalse
1STTYP street typeThe designation given to the street. (e.g. Street, Avenue, Crescent, etc.)false
1UNID unit identifierThe number or name of a specific unit contained within a building or complex, as assigned by that building or complex.false
1UNIT unit designatorIndicates the type of specific unit contained within a building or complex; e.g. Appartment, Floorfalse
1ZIP postal codeA postal code designating a region defined by the postal service.false

Source1

{
  "resourceType": "CodeSystem",
  "id": "v3-AddressPartType",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/valueset-oid",
      "valueUri": "urn:oid:2.16.840.1.113883.5.16"
    },
    {
      "extension": [
        {
          "url": "packageId",
          "valueId": "hl7.fhir.uv.xver-r2.r4b"
        },
        {
          "url": "version",
          "valueString": "0.0.1-snapshot-2"
        }
      ],
      "url": "http://hl7.org/fhir/StructureDefinition/package-source"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 0,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/1.0/ImplementationGuide/hl7.fhir.uv.xver-r2.r4b"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/1.0/ImplementationGuide/hl7.fhir.uv.xver-r2.r4b"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/v3/AddressPartType",
  "version": "1.0.2",
  "name": "v3-AddressPartType",
  "status": "draft",
  "date": "2025-09-13T15:10:02-04:00",
  "publisher": "FHIR Infrastructure",
  "contact": [
    {
      "name": "FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "caseSensitive": true,
  "content": "complete",
  "property": [
    {
      "code": "status",
      "uri": "http://hl7.org/fhir/concept-properties#status",
      "type": "code"
    },
    {
      "code": "inactive",
      "uri": "http://hl7.org/fhir/concept-properties#inactive",
      "type": "boolean"
    },
    {
      "code": "effectiveDate",
      "uri": "http://hl7.org/fhir/concept-properties#effectiveDate",
      "type": "dateTime"
    },
    {
      "code": "deprecationDate",
      "uri": "http://hl7.org/fhir/concept-properties#deprecationDate",
      "type": "dateTime"
    },
    {
      "code": "retirementDate",
      "uri": "http://hl7.org/fhir/concept-properties#retirementDate",
      "type": "dateTime"
    },
    {
      "code": "notSelectable",
      "uri": "http://hl7.org/fhir/concept-properties#notSelectable",
      "type": "boolean"
    },
    {
      "code": "parent",
      "uri": "http://hl7.org/fhir/concept-properties#parent",
      "type": "code"
    },
    {
      "code": "child",
      "uri": "http://hl7.org/fhir/concept-properties#child",
      "type": "code"
    },
    {
      "code": "partOf",
      "uri": "http://hl7.org/fhir/concept-properties#partOf",
      "type": "code"
    },
    {
      "code": "synonym",
      "uri": "http://hl7.org/fhir/concept-properties#synonym",
      "type": "code"
    },
    {
      "code": "comment",
      "uri": "http://hl7.org/fhir/concept-properties#comment",
      "type": "string"
    },
    {
      "code": "itemWeight",
      "uri": "http://hl7.org/fhir/concept-properties#itemWeight",
      "type": "decimal"
    }
  ],
  "concept": [
    {
      "code": "ADL",
      "display": "additional locator",
      "definition": "This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g. \"3rd floor, Appt. 342\"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g. Dutch \"t.o.\" means \"opposite to\" for house boats located across the street facing houses).",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "AL",
      "display": "address line",
      "definition": "Description: An address line is for either an additional locator, a delivery address or a street address.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ],
      "concept": [
        {
          "code": "DAL",
          "display": "delivery address line",
          "definition": "A delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc.  An address generally has only a delivery address line or a street address line, but not both.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "SAL",
          "display": "street address line",
          "definition": "Description: A street address line is frequently used instead of breaking out build number, street name, street type, etc. An address generally has only a delivery address line or a street address line, but not both.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        }
      ]
    },
    {
      "code": "BNN",
      "display": "building number numeric",
      "definition": "The numeric portion of a building number",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "BNR",
      "display": "building number",
      "definition": "The number of a building, house or lot alongside the street.  Also known as \"primary street number\".  This does not number the street but rather the building.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "BNS",
      "display": "building number suffix",
      "definition": "Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "CAR",
      "display": "care of",
      "definition": "The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "CEN",
      "display": "census tract",
      "definition": "A geographic sub-unit delineated for demographic purposes.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "CNT",
      "display": "country",
      "definition": "Country",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "CPA",
      "display": "county or parish",
      "definition": "A sub-unit of a state or province. (49 of the United States of America use the term \"county;\" Louisiana uses the term \"parish\".)",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "CTY",
      "display": "municipality",
      "definition": "The name of the city, town, village, or other community or delivery center",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "DEL",
      "display": "delimiter",
      "definition": "Delimiters are printed without framing white space.  If no value component is provided, the delimiter appears as a line break.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "DINST",
      "display": "delivery installation type",
      "definition": "Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "DINSTA",
      "display": "delivery installation area",
      "definition": "The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "DINSTQ",
      "display": "delivery installation qualifier",
      "definition": "A number, letter or name identifying a delivery installation; e.g. for Station A, the delivery installation qualifier would be 'A'.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "DIR",
      "display": "direction",
      "definition": "Direction (e.g. N, S, W, E)",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "DMOD",
      "display": "delivery mode",
      "definition": "Indicates the type of service offered, method of delivery.  For example: post office box, rural route, general delivery, etc.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "DMODID",
      "display": "delivery mode identifier",
      "definition": "Represents the routing information such as a letter carrier route number.  It is the identifying number of the designator (the box number or rural route number).",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "DPID",
      "display": "delivery point identifier",
      "definition": "A value that uniquely identifies the postal address.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "INT",
      "display": "intersection",
      "definition": "Description:An intersection denotes that the actual address is located AT or CLOSE TO the intersection OF two or more streets.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "POB",
      "display": "post box",
      "definition": "A numbered box located in a post station.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "PRE",
      "display": "precinct",
      "definition": "A subsection of a municipality",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "STA",
      "display": "state or province",
      "definition": "A sub-unit of a country with limited sovereignty in a federally organized country.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "STB",
      "display": "street name base",
      "definition": "The base name of a roadway or artery recognized by a municipality (excluding street type and direction)",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "STR",
      "display": "street name",
      "definition": "street name",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "STTYP",
      "display": "street type",
      "definition": "The designation given to the street.  (e.g. Street, Avenue, Crescent, etc.)",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "UNID",
      "display": "unit identifier",
      "definition": "The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "UNIT",
      "display": "unit designator",
      "definition": "Indicates the type of specific unit contained within a building or complex; e.g. Appartment, Floor",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "ZIP",
      "display": "postal code",
      "definition": "A postal code designating a region defined by the postal service.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    }
  ]
}