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

Data Type Profile: AsMailboxMSSProfile - Detailed Descriptions

Active as of 2023-12-19

Definitions for the as-mailbox-mss data type profile.

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

0. ContactPoint
2. ContactPoint.extension:as-mailbox-mss-metadata
Slice Nameas-mailbox-mss-metadata
Control0..1
TypeExtension(AS Mailbox Metadata) (Complex Extension)
4. ContactPoint.system
Pattern Valueemail
6. ContactPoint.value
ShortBoîte Aux Lettres (BAL) MSS
Must Supporttrue

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

0. ContactPoint
Definition

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

ShortDetails of a Technology mediated contact point (phone, fax, email, etc.)
Control0..*
This element is affected by the following invariants: ele-1
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())
2. ContactPoint.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 Normative)
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())
4. ContactPoint.extension:as-mailbox-mss-metadata
Slice Nameas-mailbox-mss-metadata
Definition

Extension contenant les métadonnées de la mailbox mss.

ShortAS Mailbox Metadata
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(AS Mailbox Metadata) (Complex Extension)
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. ContactPoint.system
Definition

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

Shortphone | 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
Pattern Valueemail
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. ContactPoint.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).

ShortBoîte Aux Lettres (BAL) MSSThe 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
Must Supporttrue
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()))
10. ContactPoint.use
Definition

Identifies the purpose for the contact point.

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

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

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

0. ContactPoint
Definition

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

ShortDetails of a Technology mediated contact point (phone, fax, email, etc.)
Control0..*
This element is affected by the following invariants: ele-1
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())
2. ContactPoint.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.
4. ContactPoint.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 Normative)
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 ContactPoint.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. ContactPoint.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 Normative)
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())
8. ContactPoint.extension:as-mailbox-mss-metadata
Slice Nameas-mailbox-mss-metadata
Definition

Extension contenant les métadonnées de la mailbox mss.

ShortAS Mailbox Metadata
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(AS Mailbox Metadata) (Complex Extension)
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. ContactPoint.system
Definition

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

Shortphone | fax | email | pager | url | sms | other
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
Pattern Valueemail
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. ContactPoint.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).

ShortBoîte Aux Lettres (BAL) MSS
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
Must Supporttrue
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()))
14. ContactPoint.use
Definition

Identifies the purpose for the contact point.

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

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 ContactPointUse

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()))
16. ContactPoint.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()))
18. ContactPoint.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))