Data Management with FHIR
0.1.0 - ci-build France flag

Data Management with FHIR - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: DMAddress - Detailed Descriptions

Draft as of 2025-10-23

Definitions for the DMAddress data type profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Address
Définition

An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Commentaires

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 resource).


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 resource).

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Address.extension:inseeCode
Nom de la sliceinseeCode
Définition

This extension adds the insee code (5 digits) to the address | Ajout du code insee (5 chiffres) à l'adresse postale

ShortFR Core Address Insee Code Extension
Control0..1
TypeExtension(FR Core Address Insee Code Extension) (Extension Type: Coding)
Is Modifierfalse
Must Supporttrue
Résuméfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. Address.extension:geolocation
Nom de la slicegeolocation
Définition

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

ShortThe absolute geographic location
Commentaires

The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc.

Control0..1
TypeExtension(Geolocation) (Complex Extension)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Address.extension:PmsiCodeGeo
Nom de la slicePmsiCodeGeo
Définition

Cette extension permet de porter le code géographique du lieu de résidence tel que prévu dans les RSA du PMSI

ShortCodage géographique du lieu de résidence pour les RSA du PMSI
Control0..1
TypeExtension(Codage géographique du lieu de résidence pour les RSA du PMSI) (Extension Type: code)
Is Modifierfalse
Résuméfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Address.use
Définition

The purpose of this address.

Shorthome | work | temp | old | billing - purpose of this address
Commentaires

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

The use of an address.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Résumétrue
Requirements

Allows an appropriate address to be chosen from a list of many.

ExempleGeneral: home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Address.text
Définition

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.

ShortText representation of the address
Commentaires

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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Résumétrue
Requirements

A renderable, unencoded form.

ExempleGeneral: 137 Nowhere Street, Erewhon 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Address.line
Définition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

ShortStreet name, number, direction & P.O. Box etc.
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Résumétrue
ExempleGeneral: 137 Nowhere Street
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Address.city
Définition

The name of the city, town, suburb, village or other community or delivery center.

ShortLes communes existantes sont définies ici : https://public.opendatasoft.com/explore/dataset/correspondance-code-insee-code-postal/table.Name of city, town etc.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Résumétrue
Alternate NamesMunicpality
ExempleGeneral: Erewhon
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Address.postalCode
Définition

A postal code designating a region defined by the postal service.

ShortPostal code for area
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Résumétrue
Alternate NamesZip
ExempleGeneral: 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Address
2. Address.extension:inseeCode
Nom de la sliceinseeCode
Must Supporttrue
4. Address.extension:geolocation
Nom de la slicegeolocation
Control0..1
TypeExtension(Geolocation) (Complex Extension)
Must Supporttrue
6. Address.extension:PmsiCodeGeo
Nom de la slicePmsiCodeGeo
Control0..1
TypeExtension(Codage géographique du lieu de résidence pour les RSA du PMSI) (Extension Type: code)
8. Address.text
Must Supporttrue
10. Address.line
Must Supporttrue
12. Address.city
Must Supporttrue
14. Address.postalCode
Must Supporttrue

Guidance on how to interpret the contents of this table can be foundhere

0. Address
Définition

An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Commentaires

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 resource).

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Address.id
Définition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Résuméfalse
4. Address.extension
Définition

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.

ShortAdditional content defined by implementations
Commentaires

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.

Control0..*
TypeExtension
Is Modifierfalse
Résuméfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Address.extension:inseeCode
    Nom de la sliceinseeCode
    Définition

    This extension adds the insee code (5 digits) to the address | Ajout du code insee (5 chiffres) à l'adresse postale

    ShortFR Core Address Insee Code Extension
    Control0..1
    TypeExtension(FR Core Address Insee Code Extension) (Extension Type: Coding)
    Is Modifierfalse
    Must Supporttrue
    Résuméfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Address.extension:geolocation
    Nom de la slicegeolocation
    Définition

    The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

    ShortThe absolute geographic location
    Commentaires

    The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc.

    Control0..1
    TypeExtension(Geolocation) (Complex Extension)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Address.extension:PmsiCodeGeo
    Nom de la slicePmsiCodeGeo
    Définition

    Cette extension permet de porter le code géographique du lieu de résidence tel que prévu dans les RSA du PMSI

    ShortCodage géographique du lieu de résidence pour les RSA du PMSI
    Control0..1
    TypeExtension(Codage géographique du lieu de résidence pour les RSA du PMSI) (Extension Type: code)
    Is Modifierfalse
    Résuméfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Address.use
    Définition

    The purpose of this address.

    Shorthome | work | temp | old | billing - purpose of this address
    Commentaires

    Applications can assume that an address is current unless it explicitly says that it is temporary or old.

    Control0..1
    BindingThe codes SHALL be taken from AddressUse
    (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

    The use of an address.

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Résumétrue
    Requirements

    Allows an appropriate address to be chosen from a list of many.

    ExempleGeneral: home
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Address.type
    Définition

    Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

    Shortpostal | physical | both
    Commentaires

    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 resource).

    Control0..1
    BindingThe codes SHALL be taken from AddressType
    (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

    The type of an address (physical / postal).

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Résumétrue
    ExempleGeneral: both
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Address.text
    Définition

    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.

    ShortText representation of the address
    Commentaires

    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.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Résumétrue
    Requirements

    A renderable, unencoded form.

    ExempleGeneral: 137 Nowhere Street, Erewhon 9132
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Address.line
    Définition

    This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

    ShortStreet name, number, direction & P.O. Box etc.
    Control0..*
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Résumétrue
    ExempleGeneral: 137 Nowhere Street
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. Address.city
    Définition

    The name of the city, town, suburb, village or other community or delivery center.

    ShortLes communes existantes sont définies ici : https://public.opendatasoft.com/explore/dataset/correspondance-code-insee-code-postal/table.
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Résumétrue
    Alternate NamesMunicpality
    ExempleGeneral: Erewhon
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Address.district
    Définition

    The name of the administrative area (county).

    ShortDistrict name (aka county)
    Commentaires

    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.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Résumétrue
    Alternate NamesCounty
    ExempleGeneral: Madison
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Address.state
    Définition

    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).

    ShortSub-unit of country (abbreviations ok)
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Résumétrue
    Alternate NamesProvince, Territory
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. Address.postalCode
    Définition

    A postal code designating a region defined by the postal service.

    ShortPostal code for area
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Résumétrue
    Alternate NamesZip
    ExempleGeneral: 9132
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. Address.country
    Définition

    Country - a nation as commonly understood or generally accepted.

    ShortCountry (will be ISO 3166 3 letter code; code=FRA for France)
    Commentaires

    ISO 3166 3 letter codes can be used in place of a human readable country name.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Résumétrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. Address.period
    Définition

    Time period when address was/is in use.

    ShortTime period when address was/is in use
    Control0..1
    TypePeriod
    Is Modifierfalse
    Résumétrue
    Requirements

    Allows addresses to be placed in historical context.

    ExempleGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))