CH Core (R4)
4.0.0-ballot - ballot Switzerland flag

This page is part of the CH Core (R4) (v4.0.0-ballot: STU Ballot 1) based on FHIR 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: CHCoreContactPointECH46Email - Detailed Descriptions

Active as of 2023-06-27

Definitions for the ch-core-contactpoint-ech-46-email data type profile.

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

1. ContactPoint
2. ContactPoint.system
Control10..1
Fixed Valueemail
3. ContactPoint.value
Control10..1
4. ContactPoint.use
5. ContactPoint.use.extension
Control0..?
SlicingThis element introduces a set of slices on ContactPoint.use.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. ContactPoint.use.extension:emailCategory
SliceNameemailCategory
Control0..1
TypeExtension(ECH46EmailCategory) (Extension Type: CodeableConcept)
7. ContactPoint.period
8. ContactPoint.period.start
Control0..?
9. ContactPoint.period.end
Control0..?

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

1. ContactPoint
Definition

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

Control0..* This element is affected by the following invariants: ele-1
InvariantsDefined on this element
cpt-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.system
Definition

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

Control10..1 This element is affected by the following invariants: 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
Fixed Valueemail
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. 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).

Control10..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.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. ContactPoint.use
Definition

Identifies the purpose for the contact point.

Control0..1
BindingThe codes SHALL be taken from ContactPointUse

Use of contact point.

Typecode
Is Modifiertrue
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.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. ContactPoint.use.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ContactPoint.use.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. ContactPoint.use.extension:emailCategory
SliceNameemailCategory
Definition

An Extension

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ECH46EmailCategory) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
7. ContactPoint.period
Definition

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

Control0..1
TypePeriod
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. ContactPoint.period.start
Definition

The start of the period. The boundary is inclusive.

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

If the low element is missing, the meaning is that the low boundary is not known.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. ContactPoint.period.end
Definition

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

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

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
InvariantsDefined on this element
ele-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.

1. ContactPoint
Definition

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

Control0..* This element is affected by the following invariants: ele-1
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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
3. 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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ContactPoint.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. ContactPoint.system
Definition

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

Control1..1 This element is affected by the following invariants: 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
Fixed Valueemail
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. 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).

Control1..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.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. ContactPoint.use
Definition

Identifies the purpose for the contact point.

Control0..1
BindingThe codes SHALL be taken from ContactPointUse Use of contact point
Typecode
Is Modifiertrue
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.

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. ContactPoint.use.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
8. ContactPoint.use.extension
Definition

An Extension

Control0..*
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ContactPoint.use.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. ContactPoint.use.extension:emailCategory
SliceNameemailCategory
Definition

An Extension

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ECH46EmailCategory) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. ContactPoint.use.value
Definition

Primitive value for code

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
11. 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.

Control0..1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. ContactPoint.period
Definition

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

Control0..1
TypePeriod
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. ContactPoint.period.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
14. ContactPoint.period.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ContactPoint.period.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
15. ContactPoint.period.start
Definition

The start of the period. The boundary is inclusive.

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

If the low element is missing, the meaning is that the low boundary is not known.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. ContactPoint.period.end
Definition

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

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

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))