CH Core ContactPoint eCH-0046 Email - Definitions

This page is part of the CH Core (R4) (v5.0.0-ballot: STU 5 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Data Type Profile: CHCoreContactPointECH46Email - Detailed Descriptions

Active as of 2024-05-16

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

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

0. ContactPoint
Short	CH Core ContactPoint eCH-0046 Email
2. ContactPoint.system
Control	1..?
Fixed Value	`email`
4. ContactPoint.value
Control	1..?
6. ContactPoint.use
8. ContactPoint.use.extension
Slicing	This element introduces a set of slices on `ContactPoint.use.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. ContactPoint.use.extension:emailCategory
Slice Name	emailCategory
Control	0..1
Type	Extension(eCH-0046 Email Category) (Extension Type: CodeableConcept)
12. ContactPoint.period
14. ContactPoint.period.start
16. ContactPoint.period.end

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.
Short	CH Core ContactPoint eCH-0046 EmailDetails of a Technology mediated contact point (phone, fax, email, etc.)
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	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())) cpt-2: A system is required if a value is provided. (value.empty() or system.exists())
2. ContactPoint.system
Definition	Telecommunications form for contact point - what communications system is required to make use of the contact.
Short	phone \| fax \| email \| pager \| url \| sms \| other
Control	10..1 This element is affected by the following invariants: cpt-2
Binding	The 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`) Telecommunications form for contact point.
Type	code
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Fixed Value	`email`
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. 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).
Short	The 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.
Control	10..1
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need to support legacy numbers that are not in a tightly controlled format.
Invariants	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.
Short	home \| 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.
Control	0..1
Binding	The 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`) Use of contact point.
Type	code
Is Modifier	true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. 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.
Short	ExtensionAdditional 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.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	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()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `ContactPoint.use.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. ContactPoint.use.extension:emailCategory
Slice Name	emailCategory
Definition	Optional Extension Element - found in all resources.
Short	Optional Extensions Element
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(eCH-0046 Email Category) (Extension Type: CodeableConcept)
Is Modifier	false
Invariants	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()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. ContactPoint.period
Definition	Time period when the contact point was/is in use.
Short	Time period when the contact point was/is in use
Control	0..1
Type	Period
Is Modifier	false
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. ContactPoint.period.start
Definition	The start of the period. The boundary is inclusive.
Short	Starting time with inclusive boundary
Comments	If the low element is missing, the meaning is that the low boundary is not known.
Control	0..1 This element is affected by the following invariants: per-1
Type	dateTime
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Invariants	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.
Short	End time with inclusive boundary, if not ongoing
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.
Control	0..1 This element is affected by the following invariants: per-1
Type	dateTime
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Meaning if Missing	If the end of the period is missing, it means that the period is ongoing
Invariants	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

0. ContactPoint
Definition	Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
Short	CH Core ContactPoint eCH-0046 Email
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	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.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
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.
Short	Additional 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.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	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()`)
Slicing	This element introduces a set of slices on `ContactPoint.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. ContactPoint.system
Definition	Telecommunications form for contact point - what communications system is required to make use of the contact.
Short	phone \| fax \| email \| pager \| url \| sms \| other
Control	1..1 This element is affected by the following invariants: cpt-2
Binding	The codes SHALL be taken from ContactPointSystem (required to `http://hl7.org/fhir/ValueSet/contact-point-system\|4.0.1`) Telecommunications form for contact point.
Type	code
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Fixed Value	`email`
Invariants	ele-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).
Short	The 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.
Control	1..1
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need to support legacy numbers that are not in a tightly controlled format.
Invariants	ele-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.
Short	home \| 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.
Control	0..1
Binding	The codes SHALL be taken from ContactPointUse (required to `http://hl7.org/fhir/ValueSet/contact-point-use\|4.0.1`) Use of contact point.
Type	code
Is Modifier	true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. ContactPoint.use.id
Definition	unique id for the element within a resource (for internal references)
Short	xml:id (or equivalent in JSON)
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
14. ContactPoint.use.extension
Definition	An Extension
Short	Extension
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Invariants	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()`)
Slicing	This element introduces a set of slices on `ContactPoint.use.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
16. ContactPoint.use.extension:emailCategory
Slice Name	emailCategory
Definition	Optional Extension Element - found in all resources.
Short	Optional Extensions Element
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(eCH-0046 Email Category) (Extension Type: CodeableConcept)
Is Modifier	false
Invariants	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()`)
18. ContactPoint.use.value
Definition	Primitive value for code
Short	Primitive value for code
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
20. 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.
Short	Specify 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.
Control	0..1
Type	positiveInt
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. ContactPoint.period
Definition	Time period when the contact point was/is in use.
Short	Time period when the contact point was/is in use
Control	0..1
Type	Period
Is Modifier	false
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. 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.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
26. 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.
Short	Additional 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.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	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()`)
Slicing	This element introduces a set of slices on `ContactPoint.period.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
28. ContactPoint.period.start
Definition	The start of the period. The boundary is inclusive.
Short	Starting time with inclusive boundary
Comments	If the low element is missing, the meaning is that the low boundary is not known.
Control	0..1 This element is affected by the following invariants: per-1
Type	dateTime
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. 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.
Short	End time with inclusive boundary, if not ongoing
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.
Control	0..1 This element is affected by the following invariants: per-1
Type	dateTime
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Meaning if Missing	If the end of the period is missing, it means that the period is ongoing
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)