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

Extension: AsPractitionerRoleNameExtension - Detailed Descriptions

Active as of 2023-07-18

Definitions for the as-ext-practitionerrole-name extension.

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

1. Extension
Definition

Extension créée dans le cadre de l'Annuaire Santé pour définir l'identité d’exercice d’un professionnel.

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

Concaténation des champs MOS : civilite + nomExercice + prenom

2. Extension.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. Extension.extension
Definition

An Extension

Control0..0 This element is affected by the following invariants: ele-1
TypeExtension
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 Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Extension.url
Definition

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

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

Fixed Valuehttps://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-practitionerrole-name
5. Extension.value[x]
Definition

A human's name with the ability to identify parts and usage.

Control0..1 This element is affected by the following invariants: ele-1
TypeHumanName(FrHumanName)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.

6. Extension.value[x].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.
7. Extension.value[x].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 Extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
8. Extension.value[x].extension:assemblyOrder
SliceNameassemblyOrder
Definition

A code that represents the preferred display order of the components of this human name.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(assembly-order) (Extension Type: code)
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())
9. Extension.value[x].use
Definition

Identifies the purpose for this name.

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

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Extension.value[x].text
Definition

Specifies the entire name as it should be displayed e.g. on an application UI. 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 a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Extension.value[x].family
Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

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

Synonyme MOS : nomExercice

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Extension.value[x].given
Definition

Given name.

Control0..* This element is affected by the following invariants: ele-1
Typestring
Must Supporttrue
Summarytrue
Alternate Namesfirst name, middle name
Comments

prenom

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Extension.value[x].prefix
Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

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_J78-Civilite-RASS/FHIR/JDV-J78-Civilite-RASS; other codes may be used where these codes are not suitable Civilités des personnes physiques du RAS
Typestring
Summarytrue
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()))
14. Extension.value[x].suffix
Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Control0..* This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from https://mos.esante.gouv.fr/NOS/JDV_J79-CiviliteExercice-RASS/FHIR/JDV-J79-CiviliteExercice-RASS; other codes may be used where these codes are not suitable Civilités d'exercice d'un professionnel du RAS
Typestring
Must Supporttrue
Summarytrue
Comments

Synonyme MOS : civilite

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Extension.value[x].period
Definition

Indicates the period of time when this name was valid for the named person.

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

Allows names 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.

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