Annuaire Santé
1.0.0-ballot-2 - STU1

This page is part of the Guide d'implémentation FHIR - Annuaire de santé (v1.0.0-ballot-2: Release) 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 2023-07-18

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

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

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

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

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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
3. 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.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Normative)
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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 are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Address.extension:inseeCode
SliceNameinseeCode
Definition

Optional Extension Element - found in all resources.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(FrAddressInseeCode) (Extension Type: Coding)
Standards StatusNormative (from Normative)
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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())
5. Address.use
Definition

The purpose of this address.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from AddressUse The use of an address
Typecode
Is Modifiertrue
Summarytrue
Requirements

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

Comments

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

Example
General:home
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. 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.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from AddressType The type of an address (physical / postal)
Typecode
Summarytrue
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).

Example
General:both
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. 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.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Requirements

A renderable, unencoded form.

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.

Example
General:137 Nowhere Street, Erewhon 9132
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. 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.

Control0..* This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Example
General:137 Nowhere Street
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
10. 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.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Normative)
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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 are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
11. Address.line.extension:careOf
SliceNamecareOf
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.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(ADXP-careOf) (Extension Type: string)
InvariantsDefined on this element
ele-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.line.extension:additionalLocator
SliceNameadditionalLocator
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).

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(ADXP-additionalLocator) (Extension Type: string)
InvariantsDefined on this element
ele-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())
13. Address.line.extension:houseNumber
SliceNamehouseNumber
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.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(ADXP-houseNumber) (Extension Type: string)
InvariantsDefined on this element
ele-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())
14. Address.line.extension:buildingNumberSuffix
SliceNamebuildingNumberSuffix
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(ADXP-buildingNumberSuffix) (Extension Type: string)
InvariantsDefined on this element
ele-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())
15. Address.line.extension:streetNameType
SliceNamestreetNameType
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(ADXP-streetNameType) (Extension Type: string)
InvariantsDefined on this element
ele-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())
16. Address.line.extension:streetNamebase
SliceNamestreetNamebase
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(ADXP-streetNameBase) (Extension Type: string)
InvariantsDefined on this element
ele-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())
17. Address.line.extension:postBox
SliceNamepostBox
Definition

A numbered box located in a post station.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(ADXP-postBox) (Extension Type: string)
InvariantsDefined on this element
ele-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())
18. Address.line.value
Definition

Primitive value for string

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Max Length1048576
19. Address.city
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Alternate NamesMunicpality
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Example
General:Erewhon
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Address.district
Definition

The name of the administrative area (county).

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS
Typestring
Must Supporttrue
Summarytrue
Alternate NamesCounty
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.

Example
General:Madison
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. 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).

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Alternate NamesProvince, Territory
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Address.postalCode
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
Typestring
Summarytrue
Alternate NamesZip
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Example
General:9132
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Address.country
Definition

Country - a nation as commonly understood or generally accepted.

Control0..1 This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from https://mos.esante.gouv.fr/NOS/JDV_J74-Pays-RASS/FHIR/JDV-J74-Pays-RASS
Typestring
Must Supporttrue
Summarytrue
Comments

ISO 3166 3 letter codes can be used in place of a full country name. FRA for France.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Address.period
Definition

Time period when address was/is in use.

Control0..1 This element is affected by the following invariants: ele-1
TypePeriod
Standards StatusNormative (from Normative)
Summarytrue
Requirements

Allows addresses to be placed in historical context.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Example
General:<valuePeriod xmlns="http://hl7.org/fhir">
  <start value="2010-03-23"/>
  <end value="2010-07-01"/>
</valuePeriod>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
per-1: If present, start SHALL have a lower value than end (: start.hasValue().not() or end.hasValue().not() or (start <= end))