Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions
| Draft as of 2023-10-17 |
Definitions for the zib-ContactInformation-TelephoneNumbers data type profile.
Guidance on how to interpret the contents of this table can be found here
| 0. ContactPoint | |
| Short | TelephoneNumbers |
| Comments | Implementation of the "TelephoneNumbers" concept of zib ContactInformation. |
| Alternate Names | Telefoonnummers |
| 2. ContactPoint.extension:comment | |
| Slice Name | comment |
| Control | 0..1 |
| Type | Extension(ext Comment) (Extension Type: string) |
| 4. ContactPoint.extension:comment.value[x] | |
| Definition | Explanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionnels) or that availability by phone is only possible during a specified part of the day. |
| Short | Comment |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Alternate Names | Toelichting |
| 6. ContactPoint.system | |
| Definition | The telecom or device type that the telephone number is connected to. |
| Short | TelecomType |
| Control | 1..? |
| Binding | The codes SHALL be taken from http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem: Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem. |
| Alternate Names | TelecomType |
| 8. ContactPoint.system.extension:telecomType | |
| Slice Name | telecomType |
| Control | 0..1 |
| Type | Extension(ext CodeSpecification) (Extension Type: CodeableConcept) |
| 10. ContactPoint.system.extension:telecomType.value[x] | |
| Definition | The telecom or device type that the telephone number is connected to. |
| Short | TelecomType |
| Binding | The codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.6.1--20200901000000 |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Alternate Names | TelecomType |
| 12. ContactPoint.value | |
| Definition | The person's telephone number. |
| Short | TelephoneNumber |
| Alternate Names | Telefoonnummer |
| 14. ContactPoint.use | |
| Definition | NumberType indicates whether the number is a landline, temporary, work telephone number. |
| Short | NumberType |
| Binding | The codes SHALL be taken from http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse: Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse. |
| Alternate Names | NummerSoort |
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 | TelephoneNumbersDetails of a Technology mediated contact point (phone, fax, email, etc.) |
| Comments | Implementation of the "TelephoneNumbers" concept of zib ContactInformation. Please note that, although the zib concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Alternate Names | Telefoonnummers |
| 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.extension:comment | |
| Slice Name | comment |
| Definition | Optional Extension Element - found in all resources. |
| Short | Optional Extensions Element |
| Control | 0..1 |
| Type | Extension(ext Comment) (Extension Type: string) |
| 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()) |
| 4. ContactPoint.extension:comment.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://nictiz.nl/fhir/StructureDefinition/ext-Comment |
| 6. ContactPoint.extension:comment.value[x] | |
| Definition | Explanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionnels) or that availability by phone is only possible during a specified part of the day. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | CommentValue of extension |
| Control | 0..1 |
| Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Alternate Names | Toelichting |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. ContactPoint.system | |
| Definition | The telecom or device type that the telephone number is connected to. Telecommunications form for contact point - what communications system is required to make use of the contact. |
| Short | TelecomTypephone | 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 http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem. 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 |
| Alternate Names | TelecomType |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. ContactPoint.system.extension:telecomType | |
| Slice Name | telecomType |
| 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(ext CodeSpecification) (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.system.extension:telecomType.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification |
| 14. ContactPoint.system.extension:telecomType.value[x] | |
| Definition | The telecom or device type that the telephone number is connected to. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | TelecomTypeValue of extension |
| Control | 0..1 |
| Binding | The codes SHALL be taken from For codes, see http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.6.1--20200901000000 |
| Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Alternate Names | TelecomType |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. ContactPoint.value | |
| Definition | The person's telephone number. The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
| Short | TelephoneNumberThe 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 | 0..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. |
| Alternate Names | Telefoonnummer |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. ContactPoint.use | |
| Definition | NumberType indicates whether the number is a landline, temporary, work telephone number. Identifies the purpose for the contact point. |
| Short | NumberTypehome | 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 http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse. 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. |
| Alternate Names | NummerSoort |
| 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 | TelephoneNumbers |
| Comments | Implementation of the "TelephoneNumbers" concept of zib ContactInformation. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Alternate Names | Telefoonnummers |
| 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 6. ContactPoint.extension:comment | |
| Slice Name | comment |
| Definition | Optional Extension Element - found in all resources. |
| Short | Optional Extensions Element |
| Control | 0..1 |
| Type | Extension(ext Comment) (Extension Type: string) |
| 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()) |
| 8. ContactPoint.extension:comment.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 |
| 10. ContactPoint.extension:comment.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.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 12. ContactPoint.extension:comment.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://nictiz.nl/fhir/StructureDefinition/ext-Comment |
| 14. ContactPoint.extension:comment.value[x] | |
| Definition | Explanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionnels) or that availability by phone is only possible during a specified part of the day. |
| Short | Comment |
| Control | 0..1 |
| Type | string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Alternate Names | Toelichting |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. ContactPoint.system | |
| Definition | The telecom or device type that the telephone number is connected to. |
| Short | TelecomType |
| Control | 1..1 This element is affected by the following invariants: cpt-2 |
| Binding | The codes SHALL be taken from http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem: Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Alternate Names | TelecomType |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. ContactPoint.system.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 |
| 20. ContactPoint.system.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.system.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 22. ContactPoint.system.extension:telecomType | |
| Slice Name | telecomType |
| 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(ext CodeSpecification) (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()) |
| 24. ContactPoint.system.extension:telecomType.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.system.extension:telecomType.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.system.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 28. ContactPoint.system.extension:telecomType.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification |
| 30. ContactPoint.system.extension:telecomType.value[x] | |
| Definition | The telecom or device type that the telephone number is connected to. |
| Short | TelecomType |
| Control | 0..1 |
| Binding | The codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.6.1--20200901000000 |
| Type | CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Alternate Names | TelecomType |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. ContactPoint.system.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 |
| 34. ContactPoint.value | |
| Definition | The person's telephone number. |
| Short | TelephoneNumber |
| Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
| Control | 0..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. |
| Alternate Names | Telefoonnummer |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. ContactPoint.use | |
| Definition | NumberType indicates whether the number is a landline, temporary, work telephone number. |
| Short | NumberType |
| 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 http://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse: Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse. |
| 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. |
| Alternate Names | NummerSoort |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 38. 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())) |
| 40. 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())) |