Guide d'implémentation Fr Core
2.0.0-ballot - trial-use France flag

This page is part of the Guide d'implémentation Fr Core (v2.0.0-ballot: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Data Type Profile: FRCoreContactPointProfile - Detailed Descriptions

Draft as of 2024-02-20

Definitions for the fr-core-contact-point data type profile.

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

0. ContactPoint
2. ContactPoint.extension:emailType
Slice NameemailType
Control0..1
TypeExtension(FR Core Contact Point Email Type Extension) (Extension Type: Coding)
4. ContactPoint.system
Control1..?
6. ContactPoint.value
Control1..?

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
Is Modifierfalse
Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
ele-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.extension:emailType
Slice NameemailType
Definition

Extension on the ContactPoint datatype. This extension allows to specify the type of mail used to contact the person (MSSsanté|Apicrypt|OSM|Autre).

ShortType of email | type de messagerie électronique
Control0..1
TypeExtension(FR Core Contact Point Email Type Extension) (Extension Type: Coding)
Is Modifierfalse
Summaryfalse
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())
4. 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
Control10..1
This element is affected by the following invariants: cpt-2
BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
(required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
Typecode
Is Modifierfalse
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()))
6. 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).

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
Typestring
Is Modifierfalse
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()))
8. 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
BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
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
Is Modifierfalse
Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
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
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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..*
TypeExtension
Is Modifierfalse
Summaryfalse
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

Extension on the ContactPoint datatype. This extension allows to specify the type of mail used to contact the person (MSSsanté|Apicrypt|OSM|Autre).

ShortType of email | type de messagerie électronique
Control0..1
TypeExtension(FR Core Contact Point Email Type Extension) (Extension Type: Coding)
Is Modifierfalse
Summaryfalse
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.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
Control1..1
This element is affected by the following invariants: cpt-2
BindingThe codes SHALL be taken from ContactPointSystem
(required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
Typecode
Is Modifierfalse
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()))
10. 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).

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
Typestring
Is Modifierfalse
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()))
12. 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
BindingThe codes SHALL be taken from ContactPointUse
(required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
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()))
14. 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
TypepositiveInt
Is Modifierfalse
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. ContactPoint.period
Definition

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

ShortTime period when the contact point was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))