ContactExtension - Definitions - DK MedCom Core v2.4.0

DK MedCom Core
2.4.0 - release Denmark flag

This page is part of the DK MedCom Core (v2.4.0: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.3.0. For a full list of available versions, see the Directory of published versions

Extension: MedComCoreContactExtension - Detailed Descriptions

Active as of 2024-06-27

Definitions for the medcom-core-contact-extension extension.

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

0. Extension
Definition	Extension that contains the contact information
Short	ContactExtension
2. Extension.extension
Control	0..0
4. Extension.url
Fixed Value	`http://medcomfhir.dk/ig/core/StructureDefinition/medcom-core-contact-extension`
6. Extension.value[x]
Control	1..?
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Slicing	This element introduces a set of slices on `Extension.value[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
8. Extension.value[x]:valueContactPoint
Slice Name	valueContactPoint
Control	1..1
Type	ContactPoint
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
10. Extension.value[x]:valueContactPoint.system
Must Support	true
Pattern Value	`phone`
12. Extension.value[x]:valueContactPoint.value
Short	Shall contain a relevant telephone number.
Control	1..?
Must Support	true
Invariants	medcom-core-contact: The telephone number may include + and numbers from 0-9 (`matches('[+]?[-0-9]')`)

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

0. Extension
Definition	Extension that contains the contact information Optional Extension Element - found in all resources.
Short	ContactExtensionOptional Extensions Element
Control	0..* This element is affected by the following invariants: ele-1
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())
2. Extension.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..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 `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Extension.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://medcomfhir.dk/ig/core/StructureDefinition/medcom-core-contact-extension`
6. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	10..1
Type	ContactPoint, 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, string, Contributor, oid, instant, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing	This element introduces a set of slices on `Extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
8. Extension.value[x]:valueContactPoint
Slice Name	valueContactPoint
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	10..1
Type	ContactPoint, 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, string, Contributor, oid, instant, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Extension.value[x]:valueContactPoint.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	0..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
Must Support	true
Summary	true
Pattern Value	`phone`
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Extension.value[x]:valueContactPoint.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	Shall contain a relevant telephone number.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
Must Support	true
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())) medcom-core-contact: The telephone number may include + and numbers from 0-9 (`matches('[+]?[-0-9]')`)
14. Extension.value[x]:valueContactPoint.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()))

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

0. Extension
Definition	Extension that contains the contact information
Short	ContactExtension
Control	0..* This element is affected by the following invariants: ele-1
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()`)
2. Extension.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. Extension.extension
Definition	An Extension
Short	Extension
Control	0..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 `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Extension.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://medcomfhir.dk/ig/core/StructureDefinition/medcom-core-contact-extension`
8. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	1..1
Type	ContactPoint
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing	This element introduces a set of slices on `Extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
10. Extension.value[x]:valueContactPoint
Slice Name	valueContactPoint
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	1..1
Type	ContactPoint
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Extension.value[x]:valueContactPoint.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
14. Extension.value[x]:valueContactPoint.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 `Extension.value[x].extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
16. Extension.value[x]:valueContactPoint.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	0..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
Must Support	true
Summary	true
Pattern Value	`phone`
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. Extension.value[x]:valueContactPoint.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	Shall contain a relevant telephone number.
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
Must Support	true
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())`) medcom-core-contact: The telephone number may include + and numbers from 0-9 (`matches('[+]?[-0-9]')`)
20. Extension.value[x]:valueContactPoint.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())`)
22. Extension.value[x]:valueContactPoint.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())`)
24. Extension.value[x]:valueContactPoint.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())`)

IG © 2021+ MedCom. Package medcom.fhir.dk.core#2.4.0 based on FHIR 4.0.1. Generated 2024-06-27
Links: Table of Contents | QA Report | Accessibility statement (Tilgængelighedserklæring)