Search FHIR

Annuaire Santé
1.1.0-snapshot-5 - final-text France flag

This page is part of the Guide d'implémentation FHIR - Annuaire de santé (v1.1.0-snapshot-5: 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: AS Address Extended Datatype Profile

Official URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-address-extended Version: 1.1.0-snapshot-5
Active as of 2025-02-12 Computable Name: AsAddressExtendedProfile

Datatype profile créé à partir de FrAddress dans le contexte de l’Annuaire Santé pour slicer Address.line.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... inseeCode 0..1 Coding FR Core Address Insee Code Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-address-insee-code
Binding: FR Core ValueSet INSEE code (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
... city Σ 0..1 string Les communes existantes sont définies ici : https://public.opendatasoft.com/explore/dataset/correspondance-code-insee-code-postal/table.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
... postalCode Σ 0..1 string Postal code for area
ele-1: All FHIR elements must have a @value or children
Example General: 9132
... country SΣ 0..1 string Country (will be ISO 3166 3 letter code; code=FRA for France)
Binding: JDV_J256-Pays (required)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Address.districtrequiredJDV_J258-Departement
https://mos.esante.gouv.fr/NOS/JDV_J258-Departement/FHIR/JDV-J258-Departement
Address.countryrequiredJDV_J256-Pays
https://mos.esante.gouv.fr/NOS/JDV_J256-Pays/FHIR/JDV-J256-Pays

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from FRCoreAddressProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for extension Content/Rules for all slices
.... extension:inseeCode 0..1 FRCoreAddressInseeCodeExtension FR Core Address Insee Code Extension
... line
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... careOf 0..1 string pointRemise (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
..... additionalLocator 0..1 string complementPointGeographique (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... houseNumber 0..1 string numeroVoie(Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... buildingNumberSuffix 0..1 string (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
..... streetNameType 0..1 (Complex) typeVoie (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameType
...... value[x] 1..1 string Value of extension
Binding: JDV_J103-TypeVoie-RASS (required)
..... postBox 0..1 string mentionDistribution (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... streetNameBase 0..1 string libelleVoie (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase
..... lieuDit 0..1 string lieuDit (Adresse) : Lieu qui porte un nom rappelant une particularité topographique ou historique.
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-lieu-dit
... city 0..1 string Les communes existantes sont définies ici : https://public.opendatasoft.com/explore/dataset/correspondance-code-insee-code-postal/table.
... postalCode 0..1 string Postal code for area
... country S 0..1 string Country (will be ISO 3166 3 letter code; code=FRA for France)
Binding: JDV_J256-Pays (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Address.line.extension:streetNameType.value[x]requiredJDV_J103-TypeVoie-RASS
https://mos.esante.gouv.fr/NOS/JDV_J103-TypeVoie-RASS/FHIR/JDV-J103-TypeVoie-RASS
Address.districtrequiredJDV_J258-Departement
https://mos.esante.gouv.fr/NOS/JDV_J258-Departement/FHIR/JDV-J258-Departement
Address.countryrequiredJDV_J256-Pays
https://mos.esante.gouv.fr/NOS/JDV_J256-Pays/FHIR/JDV-J256-Pays
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... inseeCode 0..1 Coding FR Core Address Insee Code Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-address-insee-code
Binding: FR Core ValueSet INSEE code (required)
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... careOf 0..1 string pointRemise (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
..... additionalLocator 0..1 string complementPointGeographique (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... houseNumber 0..1 string numeroVoie(Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... buildingNumberSuffix 0..1 string (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
..... streetNameType 0..1 (Complex) typeVoie (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameType
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameType"
...... value[x] 1..1 string Value of extension
Binding: JDV_J103-TypeVoie-RASS (required)
..... postBox 0..1 string mentionDistribution (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... streetNameBase 0..1 string libelleVoie (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase
..... lieuDit 0..1 string lieuDit (Adresse) : Lieu qui porte un nom rappelant une particularité topographique ou historique.
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-lieu-dit
.... value 0..1 string Primitive value for string
Max Length:1048576
... city Σ 0..1 string Les communes existantes sont définies ici : https://public.opendatasoft.com/explore/dataset/correspondance-code-insee-code-postal/table.
Example General: Erewhon
... district SΣ 0..1 string District name (aka county)
Binding: JDV_J258-Departement (required)
Example General: Madison
... state Σ 0..1 string Sub-unit of country (abbreviations ok)
... postalCode Σ 0..1 string Postal code for area
Example General: 9132
... country SΣ 0..1 string Country (will be ISO 3166 3 letter code; code=FRA for France)
Binding: JDV_J256-Pays (required)
... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Address.line.extension:streetNameType.value[x]requiredJDV_J103-TypeVoie-RASS
https://mos.esante.gouv.fr/NOS/JDV_J103-TypeVoie-RASS/FHIR/JDV-J103-TypeVoie-RASS
Address.districtrequiredJDV_J258-Departement
https://mos.esante.gouv.fr/NOS/JDV_J258-Departement/FHIR/JDV-J258-Departement
Address.countryrequiredJDV_J256-Pays
https://mos.esante.gouv.fr/NOS/JDV_J256-Pays/FHIR/JDV-J256-Pays

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... inseeCode 0..1 Coding FR Core Address Insee Code Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-address-insee-code
Binding: FR Core ValueSet INSEE code (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
... city Σ 0..1 string Les communes existantes sont définies ici : https://public.opendatasoft.com/explore/dataset/correspondance-code-insee-code-postal/table.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
... postalCode Σ 0..1 string Postal code for area
ele-1: All FHIR elements must have a @value or children
Example General: 9132
... country SΣ 0..1 string Country (will be ISO 3166 3 letter code; code=FRA for France)
Binding: JDV_J256-Pays (required)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Address.districtrequiredJDV_J258-Departement
https://mos.esante.gouv.fr/NOS/JDV_J258-Departement/FHIR/JDV-J258-Departement
Address.countryrequiredJDV_J256-Pays
https://mos.esante.gouv.fr/NOS/JDV_J256-Pays/FHIR/JDV-J256-Pays

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from FRCoreAddressProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for extension Content/Rules for all slices
.... extension:inseeCode 0..1 FRCoreAddressInseeCodeExtension FR Core Address Insee Code Extension
... line
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... careOf 0..1 string pointRemise (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
..... additionalLocator 0..1 string complementPointGeographique (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... houseNumber 0..1 string numeroVoie(Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... buildingNumberSuffix 0..1 string (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
..... streetNameType 0..1 (Complex) typeVoie (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameType
...... value[x] 1..1 string Value of extension
Binding: JDV_J103-TypeVoie-RASS (required)
..... postBox 0..1 string mentionDistribution (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... streetNameBase 0..1 string libelleVoie (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase
..... lieuDit 0..1 string lieuDit (Adresse) : Lieu qui porte un nom rappelant une particularité topographique ou historique.
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-lieu-dit
... city 0..1 string Les communes existantes sont définies ici : https://public.opendatasoft.com/explore/dataset/correspondance-code-insee-code-postal/table.
... postalCode 0..1 string Postal code for area
... country S 0..1 string Country (will be ISO 3166 3 letter code; code=FRA for France)
Binding: JDV_J256-Pays (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Address.line.extension:streetNameType.value[x]requiredJDV_J103-TypeVoie-RASS
https://mos.esante.gouv.fr/NOS/JDV_J103-TypeVoie-RASS/FHIR/JDV-J103-TypeVoie-RASS
Address.districtrequiredJDV_J258-Departement
https://mos.esante.gouv.fr/NOS/JDV_J258-Departement/FHIR/JDV-J258-Departement
Address.countryrequiredJDV_J256-Pays
https://mos.esante.gouv.fr/NOS/JDV_J256-Pays/FHIR/JDV-J256-Pays

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* FRCoreAddressProfile An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... inseeCode 0..1 Coding FR Core Address Insee Code Extension
URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-address-insee-code
Binding: FR Core ValueSet INSEE code (required)
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... careOf 0..1 string pointRemise (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
..... additionalLocator 0..1 string complementPointGeographique (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... houseNumber 0..1 string numeroVoie(Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... buildingNumberSuffix 0..1 string (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
..... streetNameType 0..1 (Complex) typeVoie (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameType
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameType"
...... value[x] 1..1 string Value of extension
Binding: JDV_J103-TypeVoie-RASS (required)
..... postBox 0..1 string mentionDistribution (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... streetNameBase 0..1 string libelleVoie (Adresse)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase
..... lieuDit 0..1 string lieuDit (Adresse) : Lieu qui porte un nom rappelant une particularité topographique ou historique.
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-lieu-dit
.... value 0..1 string Primitive value for string
Max Length:1048576
... city Σ 0..1 string Les communes existantes sont définies ici : https://public.opendatasoft.com/explore/dataset/correspondance-code-insee-code-postal/table.
Example General: Erewhon
... district SΣ 0..1 string District name (aka county)
Binding: JDV_J258-Departement (required)
Example General: Madison
... state Σ 0..1 string Sub-unit of country (abbreviations ok)
... postalCode Σ 0..1 string Postal code for area
Example General: 9132
... country SΣ 0..1 string Country (will be ISO 3166 3 letter code; code=FRA for France)
Binding: JDV_J256-Pays (required)
... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Address.line.extension:streetNameType.value[x]requiredJDV_J103-TypeVoie-RASS
https://mos.esante.gouv.fr/NOS/JDV_J103-TypeVoie-RASS/FHIR/JDV-J103-TypeVoie-RASS
Address.districtrequiredJDV_J258-Departement
https://mos.esante.gouv.fr/NOS/JDV_J258-Departement/FHIR/JDV-J258-Departement
Address.countryrequiredJDV_J256-Pays
https://mos.esante.gouv.fr/NOS/JDV_J256-Pays/FHIR/JDV-J256-Pays

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron