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: AS Address Extended Datatype Profile

Official URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-address-extended Version: 1.0.0-ballot-2
Active as of 2023-07-18 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..*FrAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... inseeCode N0..1CodingOptional Extensions Element
URL: http://interopsante.org/fhir/StructureDefinition/FrAddressInseeCode
Binding: fr-insee-code (required)
... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ0..*stringStreet 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..1stringUnique id for inter-element referencing
.... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... careOf 0..*stringcareOf
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
.... additionalLocator 0..*stringadditionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
.... houseNumber 0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... buildingNumberSuffix 0..*stringbuildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
.... streetNameType 0..*stringstreetNameType
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameType
.... streetNamebase 0..*stringstreetNameBase
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase
.... postBox 0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city Σ0..1stringName of city, town etc.
Example General: Erewhon
... district SΣ0..1stringDistrict name (aka county)
Binding: https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS (required)
Example General: Madison
... state Σ0..1stringSub-unit of country (abbreviations ok)
... postalCode Σ0..1stringPostal code for area
Example General: 9132
... country SΣ0..1stringCountry (will be ISO 3166 3 letter code; code=FRA for France)
Binding: https://mos.esante.gouv.fr/NOS/JDV_J74-Pays-RASS/FHIR/JDV-J74-Pays-RASS (required)
... period ΣCN0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
​.. Address 0..*FrAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
​... district Σ0..1stringDistrict name (aka county)
Binding: https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS (required)
​... country Σ0..1stringCountry (will be ISO 3166 3 letter code; code=FRA for France)
Binding: https://mos.esante.gouv.fr/NOS/JDV_J74-Pays-RASS/FHIR/JDV-J74-Pays-RASS (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*FrAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... inseeCode N0..1CodingOptional Extensions Element
URL: http://interopsante.org/fhir/StructureDefinition/FrAddressInseeCode
Binding: fr-insee-code (required)
... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ0..*stringStreet 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..1stringUnique id for inter-element referencing
.... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... careOf 0..*stringcareOf
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
.... additionalLocator 0..*stringadditionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
.... houseNumber 0..*stringhouseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
.... buildingNumberSuffix 0..*stringbuildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
.... streetNameType 0..*stringstreetNameType
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameType
.... streetNamebase 0..*stringstreetNameBase
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase
.... postBox 0..*stringpostBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city Σ0..1stringName of city, town etc.
Example General: Erewhon
... district SΣ0..1stringDistrict name (aka county)
Binding: https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS (required)
Example General: Madison
... state Σ0..1stringSub-unit of country (abbreviations ok)
... postalCode Σ0..1stringPostal code for area
Example General: 9132
... country SΣ0..1stringCountry (will be ISO 3166 3 letter code; code=FRA for France)
Binding: https://mos.esante.gouv.fr/NOS/JDV_J74-Pays-RASS/FHIR/JDV-J74-Pays-RASS (required)
... period ΣCN0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.typerequiredAddressType
Address.districtrequiredhttps://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS
Address.countryrequiredhttps://mos.esante.gouv.fr/NOS/JDV_J74-Pays-RASS/FHIR/JDV-J74-Pays-RASS

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.extension, Address.extension:inseeCode, Address.line.extension, Address.line.extension:careOf, Address.line.extension:additionalLocator, Address.line.extension:houseNumber, Address.line.extension:buildingNumberSuffix, Address.line.extension:streetNameType, Address.line.extension:streetNamebase, Address.line.extension:postBoxMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorAddress.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)