Annuaire Santé
1.0.0-ballot-3 - trial-use France flag

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

Resource Profile: AsPersonProfile - Detailed Descriptions

Active as of 2023-12-19

Definitions for the as-person resource profile.

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

0. Person
2. Person.meta
4. Person.meta.extension:as-ext-data-trace
Slice Nameas-ext-data-trace
Control0..1
TypeExtension(AS Data Trace Extension) (Complex Extension)
Must Supporttrue
6. Person.extension:as-ext-person-nationality
Slice Nameas-ext-person-nationality
Control0..*
TypeExtension(AS Person Nationality Extension) (Complex Extension)
Must Supporttrue
8. Person.extension:as-ext-person-birth-place
Slice Nameas-ext-person-birth-place
Control0..1
TypeExtension(AS Person Birth Place Extension) (Extension Type: Address)
Must Supporttrue
10. Person.extension:as-ext-person-deceased-date-time
Slice Nameas-ext-person-deceased-date-time
Control0..1
TypeExtension(AS Person Deceased Date Time Extension) (Extension Type: dateTime)
Must Supporttrue
12. Person.name
ShortNom issu de l’état-civil.
TypeHumanName(FrHumanName)
Must Supporttrue
14. Person.name.family
ShortLe nom de famille (également nommé nom de naissance) ou le nom d'usage du professionnel.
16. Person.name.given
ShortPrénom(s) déclarés à sa naissance du professionnel.
18. Person.name.prefix
ShortCivilité du professionnel (civilite).
20. Person.telecom
ShortDifférentes instances pour les téléphones, la télécopie et l’adresse mail.
TypeContactPoint(FrContactPoint)
Must Supporttrue
22. Person.telecom.system
Short« phone » pour Téléphone et Téléphone 2 ; « fax » pour Télécopie ; « email » pour adresse e-mail
24. Person.telecom.use
Comments

« old » si les coordonnées de correspondance ont une date de fin

26. Person.gender
ShortSexe administratif du professionnel, au sens de l'état civil, masculin ou féminin (MOS : sexeAdministratif).
Must Supporttrue
28. Person.birthDate
ShortDate de naissance du professionnel, modifiée selon les règles du RNIV dans le cas des dates exceptionnelles (MOS : dateNaissance).
Must Supporttrue
30. Person.photo
Must Supporttrue
32. Person.active
ShortLa ressource est-elle active? active | inactive. true par défaut; false pour les professionnels supprimés
Must Supporttrue
34. Person.link
SlicingThis element introduces a set of slices on Person.link. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ target
36. Person.link:as-practitioner-exercice-professionnel
Slice Nameas-practitioner-exercice-professionnel
Control0..*
Must Supporttrue
38. Person.link:as-practitioner-exercice-professionnel.target
TypeReference(AS Practitioner Profile)

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

0. Person
Definition

Demographics and administrative information about a person independent of a specific health-related context.

ShortA generic person record
Comments

The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).

Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
2. Person.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
This element is affected by the following invariants: ele-1
TypeMeta
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Person.meta.extension:as-ext-data-trace
Slice Nameas-ext-data-trace
Definition

Extension créée dans le cadre de l'Annuaire Santé pour tracer l'origine de la donnée (Autorité d'Enregistrement (AE) et Système d'Information (SI)). Des études complémentaires vont être initiées pour envisager l'usage de la ressource Provenance ou meta.source

ShortDataTrace : Informe sur l'origine de la donnée (Autorité d'Enregistrement (AE) et Système d'Information (SI).
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(AS Data Trace Extension) (Complex Extension)
Must Supporttrue
Invariantsele-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())
6. Person.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
This element is affected by the following invariants: ele-1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Person.extension:as-ext-person-nationality
Slice Nameas-ext-person-nationality
Definition

Extension créée dans le cadre de l'Annuaire Santé pour prise en compte de la nationalité du professionel (Person).

ShortAS Person Nationality Extension
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(AS Person Nationality Extension) (Complex Extension)
Must Supporttrue
Invariantsele-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())
10. Person.extension:as-ext-person-birth-place
Slice Nameas-ext-person-birth-place
Definition

Extension créée dans le cadre de l'Annuaire Santé pour prise en compte du lieu de naissance du professionnel en tant que personne physique.

ShortAS Person Birth Place Extension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(AS Person Birth Place Extension) (Extension Type: Address)
Must Supporttrue
Invariantsele-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. Person.extension:as-ext-person-deceased-date-time
Slice Nameas-ext-person-deceased-date-time
Definition

Extension créée dans le cadre de l'Annuaire Santé pour prise en compte de la date de décès du professionnel (Date of death of the Person if applicable).

ShortAS Person Deceased Date Time Extension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(AS Person Deceased Date Time Extension) (Extension Type: dateTime)
Must Supporttrue
Invariantsele-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. Person.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Standards StatusNormative (from Trial Use)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-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 Person.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. Person.name
Definition

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


A name associated with the person.

ShortNom issu de l’état-civil.A name associated with the person
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.


Person may have multiple names with different uses or applicable periods.

Control0..*
This element is affected by the following invariants: ele-1
TypeHumanName(FrHumanName)
Must Supporttrue
Requirements

Need to be able to track the person by multiple names. Examples are your official name and a partner name.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Person.name.extension:assemblyOrder
Slice NameassemblyOrder
Definition

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

ShortPreferred display order of name parts
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.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(assembly-order) (Extension Type: code)
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. Person.name.use
Definition

Identifies the purpose for this name.

Shortusual | official | temp | nickname | anonymous | old | maiden
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1

The use of a human name.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Person.name.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.

ShortLe nom de famille (également nommé nom de naissance) ou le nom d'usage du professionnel.Family name (often called 'Surname')
Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate Namessurname
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Person.name.given
Definition

Given name.

ShortPrénom(s) déclarés à sa naissance du professionnel.Given names (not always 'first'). Includes middle names
Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Control0..*
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate Namesfirst name, middle name
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Person.name.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.

ShortCivilité du professionnel (civilite).Parts that come before the name
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control0..1*
This element is affected by the following invariants: ele-1
BindingUnless not suitable, these codes SHALL be taken from For codes, see JDV_J78-Civilite-RASS

Civilités des personnes physiques du RASS

Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Person.telecom
Definition

Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.


A contact detail for the person, e.g. a telephone number or an email address.

ShortDifférentes instances pour les téléphones, la télécopie et l’adresse mail.A contact detail for the person
Comments

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification.

Control0..*
This element is affected by the following invariants: ele-1
TypeContactPoint(FrContactPoint)
Must Supporttrue
Requirements

People have (primary) ways to contact them in some way such as phone, email.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
30. Person.telecom.extension:emailType
Slice NameemailType
Definition

Optional Extension Element - found in all resources.

ShortType of email | type de messagerie électronique
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.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(FrContactPointEmailType) (Extension Type: Coding)
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. Person.telecom.system
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Short« phone » pour Téléphone et Téléphone 2 ; « fax » pour Télécopie ; « email » pour adresse e-mailphone | fax | email | pager | url | sms | other
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control10..1
This element is affected by the following invariants: ele-1, cpt-2
BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1

Telecommunications form for contact point.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Person.telecom.value
Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

ShortThe actual contact point details
Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Control10..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Person.telecom.use
Definition

Identifies the purpose for the contact point.

Shorthome | work | temp | old | mobile - purpose of this contact point
Comments

« old » si les coordonnées de correspondance ont une date de fin


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

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1

Use of contact point.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Person.gender
Definition

Administrative Gender.

ShortSexe administratif du professionnel, au sens de l'état civil, masculin ou féminin (MOS : sexeAdministratif).male | female | other | unknown
Comments

The gender might not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though a clear majority of systems and contexts only support M and F.

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1

The gender of a person used for administrative purposes.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Person.birthDate
Definition

The birth date for the person.

ShortDate de naissance du professionnel, modifiée selon les règles du RNIV dans le cas des dates exceptionnelles (MOS : dateNaissance).The date on which the person was born
Comments

At least an estimated year should be provided as a guess if the real DOB is unknown.

Control0..1
This element is affected by the following invariants: ele-1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Person.photo
Definition

An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.

ShortImage of the person
Comments

When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".

Control0..1
This element is affected by the following invariants: ele-1
TypeAttachment
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
att-1: If the Attachment has data, it SHALL have a contentType (data.empty() or contentType.exists())
44. Person.active
Definition

Whether this person's record is in active use.

ShortLa ressource est-elle active? active | inactive. true par défaut; false pour les professionnels supprimésThis person's record is in active use
Control0..1
This element is affected by the following invariants: ele-1
Typeboolean
Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to be able to mark a person record as not to be used because it was created in error.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Person.link
Definition

Link to a resource that concerns the same actual person.

ShortLink to a resource that concerns the same actual person
Control0..*
This element is affected by the following invariants: ele-1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Person.link. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ target
48. Person.link.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
50. Person.link.target
Definition

The resource to which this actual person is associated.

ShortThe resource to which this actual person is associated
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Control1..1
This element is affected by the following invariants: ele-1
TypeReference(Patient, Practitioner, RelatedPerson, Person)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
52. Person.link:as-practitioner-exercice-professionnel
Slice Nameas-practitioner-exercice-professionnel
Definition

Link to a resource that concerns the same actual person.

ShortLink to a resource that concerns the same actual person
Control0..*
This element is affected by the following invariants: ele-1
TypeBackboneElement
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Person.link:as-practitioner-exercice-professionnel.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
56. Person.link:as-practitioner-exercice-professionnel.target
Definition

The resource to which this actual person is associated.

ShortThe resource to which this actual person is associated
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Control1..1
This element is affected by the following invariants: ele-1
TypeReference(AS Practitioner Profile, Patient, Practitioner, RelatedPerson, Person)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))

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

0. Person
Definition

Demographics and administrative information about a person independent of a specific health-related context.

ShortA generic person record
Comments

The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).

Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
2. Person.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Summarytrue
4. Person.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
This element is affected by the following invariants: ele-1
TypeMeta
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Person.meta.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
8. Person.meta.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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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 Person.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. Person.meta.extension:as-ext-data-trace
Slice Nameas-ext-data-trace
Definition

Extension créée dans le cadre de l'Annuaire Santé pour tracer l'origine de la donnée (Autorité d'Enregistrement (AE) et Système d'Information (SI)). Des études complémentaires vont être initiées pour envisager l'usage de la ressource Provenance ou meta.source

ShortDataTrace : Informe sur l'origine de la donnée (Autorité d'Enregistrement (AE) et Système d'Information (SI).
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(AS Data Trace Extension) (Complex Extension)
Must Supporttrue
Invariantsele-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. Person.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

ShortVersion specific identifier
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Control0..1
This element is affected by the following invariants: ele-1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Person.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

ShortWhen the resource version last changed
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Control0..1
This element is affected by the following invariants: ele-1
Typeinstant
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Person.meta.source
Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

ShortIdentifies where the resource comes from
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Control0..1
This element is affected by the following invariants: ele-1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Person.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

ShortProfiles this resource claims to conform to
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Control0..*
This element is affected by the following invariants: ele-1
Typecanonical(StructureDefinition)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Person.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

ShortSecurity Labels applied to this resource
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Control0..*
This element is affected by the following invariants: ele-1
BindingUnless not suitable, these codes SHALL be taken from All Security Labels

Security Labels from the Healthcare Privacy and Security Classification System.

TypeCoding
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Person.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

ShortTags applied to this resource
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Control0..*
This element is affected by the following invariants: ele-1
BindingFor example codes, see CommonTags

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

TypeCoding
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Person.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
This element is affected by the following invariants: ele-1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Person.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from CommonLanguages

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Person.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: ele-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Person.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
32. Person.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. 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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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 Person.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
34. Person.extension:as-ext-person-nationality
Slice Nameas-ext-person-nationality
Definition

Extension créée dans le cadre de l'Annuaire Santé pour prise en compte de la nationalité du professionel (Person).

ShortAS Person Nationality Extension
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(AS Person Nationality Extension) (Complex Extension)
Must Supporttrue
Invariantsele-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())
36. Person.extension:as-ext-person-birth-place
Slice Nameas-ext-person-birth-place
Definition

Extension créée dans le cadre de l'Annuaire Santé pour prise en compte du lieu de naissance du professionnel en tant que personne physique.

ShortAS Person Birth Place Extension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(AS Person Birth Place Extension) (Extension Type: Address)
Must Supporttrue
Invariantsele-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())
38. Person.extension:as-ext-person-deceased-date-time
Slice Nameas-ext-person-deceased-date-time
Definition

Extension créée dans le cadre de l'Annuaire Santé pour prise en compte de la date de décès du professionnel (Date of death of the Person if applicable).

ShortAS Person Deceased Date Time Extension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(AS Person Deceased Date Time Extension) (Extension Type: dateTime)
Must Supporttrue
Invariantsele-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())
40. Person.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Standards StatusNormative (from Trial Use)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-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 Person.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
42. Person.identifier
Definition

Identifier for a person within a particular scope.

ShortA human identifier for this person
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
This element is affected by the following invariants: ele-1
TypeIdentifier
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Person.name
Definition

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

ShortNom issu de l’état-civil.
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeHumanName(FrHumanName)
Must Supporttrue
Requirements

Need to be able to track the person by multiple names. Examples are your official name and a partner name.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Person.name.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
48. Person.name.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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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 Person.name.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
50. Person.name.extension:assemblyOrder
Slice NameassemblyOrder
Definition

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

ShortPreferred display order of name parts
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.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(assembly-order) (Extension Type: code)
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
52. Person.name.use
Definition

Identifies the purpose for this name.

Shortusual | official | temp | nickname | anonymous | old | maiden
Comments

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

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 because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Person.name.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.

ShortText representation of the full name
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.

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

A renderable, unencoded form.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Person.name.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.

ShortLe nom de famille (également nommé nom de naissance) ou le nom d'usage du professionnel.
Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Control0..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate Namessurname
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Person.name.given
Definition

Given name.

ShortPrénom(s) déclarés à sa naissance du professionnel.
Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Control0..*
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate Namesfirst name, middle name
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Person.name.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.

ShortCivilité du professionnel (civilite).
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control0..1
This element is affected by the following invariants: ele-1
BindingUnless not suitable, these codes SHALL be taken from JDV_J78-Civilite-RASS

Civilités des personnes physiques du RASS

Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Person.name.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.

Shortjeu de valeurs pour spécifier le titre de la personne
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control0..*
This element is affected by the following invariants: ele-1
BindingUnless not suitable, these codes SHALL be taken from JDV_J79-CiviliteExercice-RASS

Civilités d'exercice d'un professionnel du RASS

Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Person.name.period
Definition

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

ShortTime period when name was/is in use
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.

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

Allows names to be placed in historical context.

Invariantsele-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))
66. Person.telecom
Definition

Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

ShortDifférentes instances pour les téléphones, la télécopie et l’adresse mail.
Comments

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification.

Control0..*
This element is affected by the following invariants: ele-1
TypeContactPoint(FrContactPoint)
Must Supporttrue
Requirements

People have (primary) ways to contact them in some way such as phone, email.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
68. Person.telecom.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
70. Person.telecom.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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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 Person.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
72. Person.telecom.extension:emailType
Slice NameemailType
Definition

Optional Extension Element - found in all resources.

ShortType of email | type de messagerie électronique
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.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(FrContactPointEmailType) (Extension Type: Coding)
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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())
74. Person.telecom.system
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Short« phone » pour Téléphone et Téléphone 2 ; « fax » pour Télécopie ; « email » pour adresse e-mail
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1, cpt-2
BindingThe codes SHALL be taken from ContactPointSystem

Telecommunications form for contact point.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Person.telecom.value
Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

ShortThe actual contact point details
Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. Person.telecom.use
Definition

Identifies the purpose for the contact point.

Shorthome | work | temp | old | mobile - purpose of this contact point
Comments

« old » si les coordonnées de correspondance ont une date de fin

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from ContactPointUse

Use of contact point.

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Person.telecom.rank
Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

ShortSpecify preferred order of use (1 = highest)
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Control0..1
This element is affected by the following invariants: ele-1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. Person.telecom.period
Definition

Time period when the contact point was/is in use.

ShortTime period when the contact point was/is in use
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.

Control0..1
This element is affected by the following invariants: ele-1
TypePeriod
Summarytrue
Invariantsele-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))
84. Person.gender
Definition

Administrative Gender.

ShortSexe administratif du professionnel, au sens de l'état civil, masculin ou féminin (MOS : sexeAdministratif).
Comments

The gender might not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though a clear majority of systems and contexts only support M and F.

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from AdministrativeGender

The gender of a person used for administrative purposes.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Person.birthDate
Definition

The birth date for the person.

ShortDate de naissance du professionnel, modifiée selon les règles du RNIV dans le cas des dates exceptionnelles (MOS : dateNaissance).
Comments

At least an estimated year should be provided as a guess if the real DOB is unknown.

Control0..1
This element is affected by the following invariants: ele-1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Person.address
Definition

One or more addresses for the person.

ShortOne or more addresses for the person
Comments

Person may have multiple addresses with different uses or applicable periods.

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

May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Person.photo
Definition

An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.

ShortImage of the person
Comments

When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".

Control0..1
This element is affected by the following invariants: ele-1
TypeAttachment
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
att-1: If the Attachment has data, it SHALL have a contentType (data.empty() or contentType.exists())
92. Person.managingOrganization
Definition

The organization that is the custodian of the person record.

ShortThe organization that is the custodian of the person record
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Control0..1
This element is affected by the following invariants: ele-1
TypeReference(Organization)
Summarytrue
Requirements

Need to know who recognizes this person record, manages and updates it.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
94. Person.active
Definition

Whether this person's record is in active use.

ShortLa ressource est-elle active? active | inactive. true par défaut; false pour les professionnels supprimés
Control0..1
This element is affected by the following invariants: ele-1
Typeboolean
Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to be able to mark a person record as not to be used because it was created in error.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. Person.link
Definition

Link to a resource that concerns the same actual person.

ShortLink to a resource that concerns the same actual person
Control0..*
This element is affected by the following invariants: ele-1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Person.link. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ target
98. Person.link.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
100. Person.link.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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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 Person.link.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
102. Person.link.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
104. Person.link.target
Definition

The resource to which this actual person is associated.

ShortThe resource to which this actual person is associated
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Control1..1
This element is affected by the following invariants: ele-1
TypeReference(Patient, Practitioner, RelatedPerson, Person)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
106. Person.link.assurance
Definition

Level of assurance that this link is associated with the target resource.

Shortlevel1 | level2 | level3 | level4
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from IdentityAssuranceLevel

The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. Person.link:as-practitioner-exercice-professionnel
Slice Nameas-practitioner-exercice-professionnel
Definition

Link to a resource that concerns the same actual person.

ShortLink to a resource that concerns the same actual person
Control0..*
This element is affected by the following invariants: ele-1
TypeBackboneElement
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. Person.link:as-practitioner-exercice-professionnel.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
112. Person.link:as-practitioner-exercice-professionnel.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.

ShortAdditional content defined by implementations
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Trial Use)
Alternate Namesextensions, user content
Invariantsele-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 Person.link.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
114. Person.link:as-practitioner-exercice-professionnel.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
116. Person.link:as-practitioner-exercice-professionnel.target
Definition

The resource to which this actual person is associated.

ShortThe resource to which this actual person is associated
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Control1..1
This element is affected by the following invariants: ele-1
TypeReference(AS Practitioner Profile)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
118. Person.link:as-practitioner-exercice-professionnel.assurance
Definition

Level of assurance that this link is associated with the target resource.

Shortlevel1 | level2 | level3 | level4
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHALL be taken from IdentityAssuranceLevel

The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))