Skip to content

Communication Delivery Address Extension

Canonicalhttps://fhir.apps.health/StructureDefinition/nexus-communication-delivery-address
Statusdraft · 1.33.0
BaseExtension (constraint)
ContextCommunication (element)
SourceFSH · JSON

The fax number, mobile number or email address an outbound delivery was actually sent to, as dialled or addressed at the time of sending.

Elements / Details

Every element this profile touches, with its full definition. Element names in the tables link here.

Extension

Short Communication Delivery Address Extension
Definition The fax number, mobile number or email address an outbound delivery was actually sent to, as dialled or addressed at the time of sending. Required on every Communication carrying the outbound-delivery category, whether or not recipient also references a Practitioner or Organization: that resource's contact details can change after the send, and this records where the message went. A fax to a bare number with no resource behind it carries this extension and a recipient whose display is the number. system says what kind of address it is (fax, sms or email) and value carries it as sent. It is not normalised: a reader comparing addresses must normalise both sides.
Cardinality 0..*
Invariants ele-1, ext-1

Extension.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Extension.extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..0
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Extension.url

Short identifies the meaning of the extension
Definition Source of the definition for the extension code - a logical name or a URL.
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.
Cardinality 1..1
Type http://hl7.org/fhirpath/System.String
Fixed value https://fhir.apps.health/StructureDefinition/nexus-communication-delivery-address

Extension.value[x]

Short Value of extension
Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Cardinality 1..1
Type ContactPoint
Must Support yes
Invariants ele-1

Extension.value[x].id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Extension.value[x].extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Extension.value[x].system

Short phone | fax | email | pager | url | sms | other
Definition Telecommunications form for contact point - what communications system is required to make use of the contact.
Cardinality 1..1
Type code
Must Support yes
Binding contact-point-system (required)
Invariants ele-1

Extension.value[x].value

Short The actual contact point details
Definition The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
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.
Cardinality 1..1
Type string
Must Support yes
Invariants ele-1

Extension.value[x].use

Short home | work | temp | old | mobile - purpose of this contact point
Definition Identifies the purpose for the contact point.
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.
Cardinality 0..1
Type code
Modifier yes — This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Binding contact-point-use (required)
Invariants ele-1

Extension.value[x].rank

Short Specify preferred order of use (1 = highest)
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.
Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Cardinality 0..1
Type positiveInt
Invariants ele-1

Extension.value[x].period

Short Time period when the contact point was/is in use
Definition Time period when the contact point was/is in use.
Cardinality 0..1
Type Period
Invariants ele-1