LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions
Active as of 2022-11-10 |
Definitions for the cdm-communication-contact-point data type profile.
1. ContactPoint | |
2. ContactPoint.extension:contactPointCountry | |
SliceName | contactPointCountry |
Definition | The country code as defined by the ITU. This extension is used when a system wishes to designate specific parts of a phone number. |
Control | 0..1 |
Type | Extension(country) (Extension Type: string) |
3. ContactPoint.extension:contactPointExt | |
SliceName | contactPointExt |
Definition | The number that may be dialed within a private phone network or after successfully connecting to a private phone network |
Control | 0..1 |
Type | Extension(extension) (Extension Type: string) |
4. ContactPoint.extension:telAddress | |
SliceName | telAddress |
Definition | A V3 compliant, RFC 3966 conformant URI version of the telephone or fax number |
Control | 0..1 |
Type | Extension(TEL-address) (Extension Type: url) |
1. ContactPoint | |
Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Invariants | Defined 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.extension:contactPointCountry | |
SliceName | contactPointCountry |
Definition | The country code as defined by the ITU. This extension is used when a system wishes to designate specific parts of a phone number. |
Control | 0..1 |
Type | Extension(country) (Extension Type: string) |
Comments | The ContactPoint.value element SHOULD still be populated even if the extension is present. |
Invariants | Defined 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()) |
3. ContactPoint.extension:contactPointExt | |
SliceName | contactPointExt |
Definition | The number that may be dialed within a private phone network or after successfully connecting to a private phone network |
Control | 0..1 |
Type | Extension(extension) (Extension Type: string) |
Comments | The ContactPoint.value element SHOULD still be populated even if the extension is present. |
Invariants | Defined 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()) |
4. ContactPoint.extension:telAddress | |
SliceName | telAddress |
Definition | A V3 compliant, RFC 3966 conformant URI version of the telephone or fax number |
Control | 0..1 |
Type | Extension(TEL-address) (Extension Type: url) |
Comments | Note that this form is supposed to be used in CDA, but many CDA documents are not actually conformant. |
Invariants | Defined 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()) |
5. ContactPoint.use | |
Definition | Identifies the purpose for the contact point. |
Control | 0..1 |
Binding | The codes SHALL be taken from ContactPointUse Use of contact point. |
Type | code |
Is Modifier | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
1. ContactPoint | |
Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. |
Control | 0..* 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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensionsuser 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. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on ContactPoint.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. ContactPoint.extension:contactPointCountry | |
SliceName | contactPointCountry |
Definition | The country code as defined by the ITU. This extension is used when a system wishes to designate specific parts of a phone number. |
Control | 0..1 |
Type | Extension(country) (Extension Type: string) |
Comments | The ContactPoint.value element SHOULD still be populated even if the extension is present. |
Invariants | Defined 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()) |
5. ContactPoint.extension:contactPointExt | |
SliceName | contactPointExt |
Definition | The number that may be dialed within a private phone network or after successfully connecting to a private phone network |
Control | 0..1 |
Type | Extension(extension) (Extension Type: string) |
Comments | The ContactPoint.value element SHOULD still be populated even if the extension is present. |
Invariants | Defined 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()) |
6. ContactPoint.extension:telAddress | |
SliceName | telAddress |
Definition | A V3 compliant, RFC 3966 conformant URI version of the telephone or fax number |
Control | 0..1 |
Type | Extension(TEL-address) (Extension Type: url) |
Comments | Note that this form is supposed to be used in CDA, but many CDA documents are not actually conformant. |
Invariants | Defined 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.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Control | 0..1 This element is affected by the following invariants: cpt-2 |
Binding | The codes SHALL be taken from ContactPointSystem Telecommunications form for contact point |
Type | code |
Invariants | Defined on this element 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). |
Control | 0..1 |
Type | string |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
9. ContactPoint.use | |
Definition | Identifies the purpose for the contact point. |
Control | 0..1 |
Binding | The codes SHALL be taken from ContactPointUse Use of contact point |
Type | code |
Is Modifier | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
10. 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. |
Control | 0..1 |
Type | positiveInt |
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
11. ContactPoint.period | |
Definition | Time period when the contact point was/is in use. |
Control | 0..1 |
Type | Period |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |