Interweave Implementation Guide
0.1.0 - ci-build United Kingdom flag

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.

Extension: Extension UK Core Contact Preference

Official URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference Version: 2.3.0
Active as of 2023-12-07 Computable Name: ExtensionUKCoreContactPreference

Copyright/Legal: Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.

The preferred method of contact, contact times and written communication format given by a Patient or Related Person.

This extension extends the Patient and RelatedPerson resources to support the exchange of their preferred method of contact, contact times and written communication format.

Context of Use

This extension may be used on the following element(s):

  • Element ID Patient
  • Element ID RelatedPerson

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Complex Extension: The preferred method of contact, contact times and written communication format given by a Patient or Related Person.

  • PreferredContactMethod: CodeableConcept: The preferred method of contact given by a Patient or Related Person.
  • PreferredContactTimes: string, Timing: The preferred contact times given by a Patient or Related Person.
  • PreferredWrittenCommunicationFormat: CodeableConcept: The preferred written communication format given by a Patient or Related Person.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension The preferred method of contact, contact times and written communication format given by a Patient or Related Person.
... Slices for extension Content/Rules for all slices
.... extension:PreferredContactMethod 0..1 Extension Preferred Contact Method
..... extension 0..0
..... url 1..1 uri "PreferredContactMethod"
..... value[x] 1..1 CodeableConcept Preferred Contact Method
Binding: UK Core Preferred Contact Method (extensible)
.... extension:PreferredContactTimes 0..1 Extension Preferred Contact Times
..... extension 0..0
..... url 1..1 uri "PreferredContactTimes"
..... value[x] 1..1 Preferred Contact Times
...... valueString string
...... valueTiming Timing
.... extension:PreferredWrittenCommunicationFormat 0..1 Extension Preferred Written Communication Format
..... extension 0..0
..... url 1..1 uri "PreferredWrittenCommunicationFormat"
..... value[x] 1..1 CodeableConcept Preferred Written Communication Format
Binding: UK Core Preferred Written Communication Format (extensible)
... url 1..1 uri "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension The preferred method of contact, contact times and written communication format given by a Patient or Related Person.
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:PreferredContactMethod 0..1 Extension Preferred Contact Method
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "PreferredContactMethod"
..... value[x] 1..1 CodeableConcept Preferred Contact Method
Binding: UK Core Preferred Contact Method (extensible)
.... extension:PreferredContactTimes 0..1 Extension Preferred Contact Times
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "PreferredContactTimes"
..... value[x] 1..1 Preferred Contact Times
...... valueString string
...... valueTiming Timing
.... extension:PreferredWrittenCommunicationFormat 0..1 Extension Preferred Written Communication Format
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "PreferredWrittenCommunicationFormat"
..... value[x] 1..1 CodeableConcept Preferred Written Communication Format
Binding: UK Core Preferred Written Communication Format (extensible)
... url 1..1 uri "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The preferred method of contact, contact times and written communication format given by a Patient or Related Person.

  • PreferredContactMethod: CodeableConcept: The preferred method of contact given by a Patient or Related Person.
  • PreferredContactTimes: string, Timing: The preferred contact times given by a Patient or Related Person.
  • PreferredWrittenCommunicationFormat: CodeableConcept: The preferred written communication format given by a Patient or Related Person.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension The preferred method of contact, contact times and written communication format given by a Patient or Related Person.
... Slices for extension Content/Rules for all slices
.... extension:PreferredContactMethod 0..1 Extension Preferred Contact Method
..... extension 0..0
..... url 1..1 uri "PreferredContactMethod"
..... value[x] 1..1 CodeableConcept Preferred Contact Method
Binding: UK Core Preferred Contact Method (extensible)
.... extension:PreferredContactTimes 0..1 Extension Preferred Contact Times
..... extension 0..0
..... url 1..1 uri "PreferredContactTimes"
..... value[x] 1..1 Preferred Contact Times
...... valueString string
...... valueTiming Timing
.... extension:PreferredWrittenCommunicationFormat 0..1 Extension Preferred Written Communication Format
..... extension 0..0
..... url 1..1 uri "PreferredWrittenCommunicationFormat"
..... value[x] 1..1 CodeableConcept Preferred Written Communication Format
Binding: UK Core Preferred Written Communication Format (extensible)
... url 1..1 uri "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension The preferred method of contact, contact times and written communication format given by a Patient or Related Person.
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:PreferredContactMethod 0..1 Extension Preferred Contact Method
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "PreferredContactMethod"
..... value[x] 1..1 CodeableConcept Preferred Contact Method
Binding: UK Core Preferred Contact Method (extensible)
.... extension:PreferredContactTimes 0..1 Extension Preferred Contact Times
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "PreferredContactTimes"
..... value[x] 1..1 Preferred Contact Times
...... valueString string
...... valueTiming Timing
.... extension:PreferredWrittenCommunicationFormat 0..1 Extension Preferred Written Communication Format
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "PreferredWrittenCommunicationFormat"
..... value[x] 1..1 CodeableConcept Preferred Written Communication Format
Binding: UK Core Preferred Written Communication Format (extensible)
... url 1..1 uri "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:PreferredContactMethod.value[x]extensibleUKCorePreferredContactMethod (a valid code from https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod)
https://fhir.hl7.org.uk/ValueSet/UKCore-PreferredContactMethod
from this IG
Extension.extension:PreferredWrittenCommunicationFormat.value[x]extensibleUKCorePreferredWrittenCommunicationFormat (a valid code from https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat)
https://fhir.hl7.org.uk/ValueSet/UKCore-PreferredWrittenCommunicationFormat
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()