Annuaire Santé
0.1.0 - trial-use
Annuaire Santé
0.1.0 - trial-use
This page is part of the Guide d'implémentation FHIR - Annuaire de santé (v0.1.0: trial-use) 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
| Official URL: https://annuaire.sante.gouv.fr/fhir/StructureDefinition/Fr-Address-Extended | Version: 0.1.0 | |||
| Draft as of 2023-12-13 | Computable Name: FrAddressExtended | |||
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from FrAddress
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Address | 0..* | FrAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 inseeCode | N | 0..1 | Coding | Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrAddressInseeCode Binding: fr-insee-code (required) |
| frenchDepartment | 0..1 | CodeableConcept | Optional Extensions Element URL: https://annuaire.sante.gouv.fr/fhir/StructureDefinition/French-Department Binding: https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS (required): Départements (outre-mer et Monaco inclus) pour le RASS;https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS | |
| countryCode | 0..1 | code | Optional Extensions Element URL: https://annuaire.sante.gouv.fr/fhir/StructureDefinition/Address-Country-Code Binding: https://mos.esante.gouv.fr/NOS/JDV_J74-Pays-RASS/FHIR/JDV-J74-Pays-RASS (required): Pays (codes INSEE) du RASS; http://mos.asipsante.fr/NOS/TABS/JDV_J74-Pays-RASS.tabs | |
  use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Address.use | required | AddressUse |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | FrAddress | 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 | Extension Slice: Unordered, Open by value:url | |
| inseeCode | N | 0..1 | Coding | Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrAddressInseeCode Binding: fr-insee-code (required) |
| frenchDepartment | 0..1 | CodeableConcept | Optional Extensions Element URL: https://annuaire.sante.gouv.fr/fhir/StructureDefinition/French-Department Binding: https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS (required): Départements (outre-mer et Monaco inclus) pour le RASS;https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS | |
| countryCode | 0..1 | code | Optional Extensions Element URL: https://annuaire.sante.gouv.fr/fhir/StructureDefinition/Address-Country-Code Binding: https://mos.esante.gouv.fr/NOS/JDV_J74-Pays-RASS/FHIR/JDV-J74-Pays-RASS (required): Pays (codes INSEE) du RASS; http://mos.asipsante.fr/NOS/TABS/JDV_J74-Pays-RASS.tabs | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| 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 | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| careOf | 0..* | string | careOf URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf | |
| additionalLocator | 0..* | string | additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
| houseNumber | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
| buildingNumberSuffix | 0..* | string | buildingNumberSuffix URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix | |
| streetNameType | 0..* | string | streetNameType URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameType | |
| streetNamebase | 0..* | string | streetNameBase URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase | |
| postBox | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| district | Σ | 0..1 | string | District name (aka county) 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 | Σ | 0..1 | string | Country (will be ISO 3166 3 letter code; code=FRA for France) |
 period | ΣC | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Address.use | required | AddressUse |
| Address.type | required | AddressType |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| per-1 | error | Address.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) |
This structure is derived from FrAddress
Summary
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from FrAddress
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | FrAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| inseeCode | N | 0..1 | Coding | Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrAddressInseeCode Binding: fr-insee-code (required) |
| frenchDepartment | 0..1 | CodeableConcept | Optional Extensions Element URL: https://annuaire.sante.gouv.fr/fhir/StructureDefinition/French-Department Binding: https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS (required): Départements (outre-mer et Monaco inclus) pour le RASS;https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS | |
| countryCode | 0..1 | code | Optional Extensions Element URL: https://annuaire.sante.gouv.fr/fhir/StructureDefinition/Address-Country-Code Binding: https://mos.esante.gouv.fr/NOS/JDV_J74-Pays-RASS/FHIR/JDV-J74-Pays-RASS (required): Pays (codes INSEE) du RASS; http://mos.asipsante.fr/NOS/TABS/JDV_J74-Pays-RASS.tabs | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Address.use | required | AddressUse |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | FrAddress | 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 | Extension Slice: Unordered, Open by value:url | |
| inseeCode | N | 0..1 | Coding | Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrAddressInseeCode Binding: fr-insee-code (required) |
| frenchDepartment | 0..1 | CodeableConcept | Optional Extensions Element URL: https://annuaire.sante.gouv.fr/fhir/StructureDefinition/French-Department Binding: https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS (required): Départements (outre-mer et Monaco inclus) pour le RASS;https://mos.esante.gouv.fr/NOS/JDV_J84-DepartementOM-RASS/FHIR/JDV-J84-DepartementOM-RASS | |
| countryCode | 0..1 | code | Optional Extensions Element URL: https://annuaire.sante.gouv.fr/fhir/StructureDefinition/Address-Country-Code Binding: https://mos.esante.gouv.fr/NOS/JDV_J74-Pays-RASS/FHIR/JDV-J74-Pays-RASS (required): Pays (codes INSEE) du RASS; http://mos.asipsante.fr/NOS/TABS/JDV_J74-Pays-RASS.tabs | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| 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 | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| careOf | 0..* | string | careOf URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf | |
| additionalLocator | 0..* | string | additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |
| houseNumber | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
| buildingNumberSuffix | 0..* | string | buildingNumberSuffix URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix | |
| streetNameType | 0..* | string | streetNameType URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameType | |
| streetNamebase | 0..* | string | streetNameBase URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase | |
| postBox | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| district | Σ | 0..1 | string | District name (aka county) 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 | Σ | 0..1 | string | Country (will be ISO 3166 3 letter code; code=FRA for France) |
| period | ΣC | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Address.use | required | AddressUse |
| Address.type | required | AddressType |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| per-1 | error | Address.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) |
This structure is derived from FrAddress
Summary
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
