Annuaire Santé
1.1.0-snapshot - qa-preview France flag

This page is part of the Guide d'implémentation FHIR - Annuaire de santé (v1.1.0-snapshot: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

Data Type Profile: AsAddressExtendedProfile - Detailed Descriptions

Active as of 2024-07-10

Definitions for the as-address-extended data type profile.

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

0. Address
2. Address.line
4. Address.line.extension:careOf
Slice NamecareOf
ShortpointRemise (Adresse)
Control0..1
TypeExtension(ADXP Care Of) (Extension Type: string)
6. Address.line.extension:additionalLocator
Slice NameadditionalLocator
ShortcomplementPointGeographique (Adresse)
Control0..1
TypeExtension(ADXP Additional Locator) (Extension Type: string)
8. Address.line.extension:houseNumber
Slice NamehouseNumber
ShortnumeroVoie(Adresse)
Control0..1
TypeExtension(ADXP House Number) (Extension Type: string)
10. Address.line.extension:buildingNumberSuffix
Slice NamebuildingNumberSuffix
Short(Adresse)
Control0..1
TypeExtension(ADXP Building Number Suffix) (Extension Type: string)
12. Address.line.extension:streetNameType
Slice NamestreetNameType
ShorttypeVoie (Adresse)
Control0..1
TypeExtension(ADXP Street Name Type) (Extension Type: string)
14. Address.line.extension:streetNameType.value[x]
BindingThe codes SHALL be taken from JDV_J103-TypeVoie-RASS
(required to https://mos.esante.gouv.fr/NOS/JDV_J103-TypeVoie-RASS/FHIR/JDV-J103-TypeVoie-RASS)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
16. Address.line.extension:postBox
Slice NamepostBox
ShortmentionDistribution (Adresse)
Control0..1
TypeExtension(ADXP Post Box) (Extension Type: string)
18. Address.line.extension:streetNameBase
Slice NamestreetNameBase
ShortlibelleVoie (Adresse)
Control0..1
TypeExtension(ADXP Street Name Base) (Extension Type: string)
20. Address.line.extension:lieuDit
Slice NamelieuDit
ShortlieuDit (Adresse) : Lieu qui porte un nom rappelant une particularité topographique ou historique.
Control0..1
TypeExtension(AS Lieu Dit Extension) (Extension Type: string)
22. Address.district
BindingThe codes SHALL be taken from JDV_J84-DepartementOM-RASS
(required to https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS)
Must Supporttrue
24. Address.country
BindingThe codes SHALL be taken from JDV_J74-Pays-RASS
(required to https://mos.esante.gouv.fr/NOS/JDV_J74-Pays-RASS/FHIR/JDV-J74-Pays-RASS)
Must Supporttrue

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

0. Address
Definition

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

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
Slice NameinseeCode
Definition

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

ShortCode COG de la ville
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(FR Core Address Insee Code Extension) (Extension Type: Coding)
Is Modifierfalse
Summaryfalse
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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. Address.use
Definition

The purpose of this address.

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

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

Control0..1
This element is affected by the following invariants: ele-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
Summarytrue
Requirements

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

Example<br/><b>General</b>:home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Address.district
Definition

The name of the administrative area (county).

ShortDistrict name (aka county)
Comments

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
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from For codes, see JDV_J84-DepartementOM-RASS
(required to https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS)
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesCounty
Example<br/><b>General</b>:Madison
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Address.country
Definition

Country - a nation as commonly understood or generally accepted.

ShortCountry (will be ISO 3166 3 letter code; code=FRA for France)Country (e.g. can be ISO 3166 2 or 3 letter code)
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from For codes, see JDV_J74-Pays-RASS
(required to https://mos.esante.gouv.fr/NOS/JDV_J74-Pays-RASS/FHIR/JDV-J74-Pays-RASS)
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
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 found here

0. Address
Definition

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

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
Definition

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.
Summaryfalse
4. Address.extension
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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
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
    Slice NameinseeCode
    Definition

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

    ShortCode COG de la ville
    Control0..1
    TypeExtension(FR Core Address Insee Code Extension) (Extension Type: Coding)
    Is Modifierfalse
    Summaryfalse
    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
    Definition

    The purpose of this address.

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

    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
    Summarytrue
    Requirements

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

    Example<br/><b>General</b>:home
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Address.type
    Definition

    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
    Comments

    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
    Summarytrue
    Example<br/><b>General</b>:both
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Address.text
    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.

    ShortText representation of the address
    Comments

    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
    Summarytrue
    Requirements

    A renderable, unencoded form.

    Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Address.line
    Definition

    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
    Summarytrue
    Example<br/><b>General</b>:137 Nowhere Street
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Address.line.id
    Definition

    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
    XML FormatIn the XML format, this property is represented as an attribute.
    18. Address.line.extension
    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.

    ShortAdditional content defined by implementations
    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.

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension
    Standard StatusNormative (from Normative)
    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.line.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 20. Address.line.extension:careOf
      Slice NamecareOf
      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.

      ShortpointRemise (Adresse)
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(ADXP Care Of) (Extension Type: string)
      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())
      22. Address.line.extension:additionalLocator
      Slice NameadditionalLocator
      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).

      ShortcomplementPointGeographique (Adresse)
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(ADXP Additional Locator) (Extension Type: string)
      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())
      24. Address.line.extension:houseNumber
      Slice NamehouseNumber
      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.

      ShortnumeroVoie(Adresse)
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(ADXP House Number) (Extension Type: string)
      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())
      26. Address.line.extension:buildingNumberSuffix
      Slice NamebuildingNumberSuffix
      Definition

      Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number.

      Short(Adresse)
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(ADXP Building Number Suffix) (Extension Type: string)
      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())
      28. Address.line.extension:streetNameType
      Slice NamestreetNameType
      Definition

      The designation given to the street. (e.g. Street, Avenue, Crescent, etc.).

      ShorttypeVoie (Adresse)
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(ADXP Street Name Type) (Extension Type: string)
      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())
      30. Address.line.extension:streetNameType.id
      Definition

      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
      This element is affected by the following invariants: ele-1
      Typeid
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      32. Address.line.extension:streetNameType.extension
      Definition

      An Extension

      ShortExtension
      Control0..0
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      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.line.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 34. Address.line.extension:streetNameType.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        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.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameType
        36. Address.line.extension:streetNameType.value[x]
        Definition

        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortValue of extension
        Control1..1
        This element is affected by the following invariants: ext-1
        BindingThe codes SHALL be taken from JDV_J103-TypeVoie-RASS
        (required to https://mos.esante.gouv.fr/NOS/JDV_J103-TypeVoie-RASS/FHIR/JDV-J103-TypeVoie-RASS)
        Typestring
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. Address.line.extension:postBox
        Slice NamepostBox
        Definition

        A numbered box located in a post station.

        ShortmentionDistribution (Adresse)
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(ADXP Post Box) (Extension Type: string)
        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())
        40. Address.line.extension:streetNameBase
        Slice NamestreetNameBase
        Definition

        The base name of a roadway or artery recognized by a municipality (excluding street type and direction).

        ShortlibelleVoie (Adresse)
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(ADXP Street Name Base) (Extension Type: string)
        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())
        42. Address.line.extension:lieuDit
        Slice NamelieuDit
        Definition

        Extension créée dans le cadre de l'Annuaire Santé pour indiquer le lieu dit

        ShortlieuDit (Adresse) : Lieu qui porte un nom rappelant une particularité topographique ou historique.
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(AS Lieu Dit Extension) (Extension Type: string)
        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())
        44. Address.line.value
        Definition

        Primitive value for string

        ShortPrimitive value for string
        Control0..1
        Typestring
        XML FormatIn the XML format, this property is represented as an attribute.
        Max Length:1048576
        46. Address.city
        Definition

        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
        Summarytrue
        Alternate NamesMunicpality
        Example<br/><b>General</b>:Erewhon
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        48. Address.district
        Definition

        The name of the administrative area (county).

        ShortDistrict name (aka county)
        Comments

        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
        BindingThe codes SHALL be taken from JDV_J84-DepartementOM-RASS
        (required to https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS)
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Alternate NamesCounty
        Example<br/><b>General</b>:Madison
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        50. Address.state
        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).

        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
        Summarytrue
        Alternate NamesProvince, Territory
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        52. Address.postalCode
        Definition

        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
        Summarytrue
        Alternate NamesZip
        Example<br/><b>General</b>:9132
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        54. Address.country
        Definition

        Country - a nation as commonly understood or generally accepted.

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

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

        Control0..1
        BindingThe codes SHALL be taken from JDV_J74-Pays-RASS
        (required to https://mos.esante.gouv.fr/NOS/JDV_J74-Pays-RASS/FHIR/JDV-J74-Pays-RASS)
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        56. Address.period
        Definition

        Time period when address was/is in use.

        ShortTime period when address was/is in use
        Control0..1
        TypePeriod
        Is Modifierfalse
        Summarytrue
        Requirements

        Allows addresses to be placed in historical context.

        Example<br/><b>General</b>:{ "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()))