LinuxForHealth FHIR Implementation Guide
8.0.0 - draft United States of America flag

LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions

Extension: Communication Opt-Out

Official URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-opt-out Version: 8.0.0
Active as of 2022-11-10 Computable Name: CommunicationOptOut

Opt-out patient for communications by product and/or mode

Context of Use

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

  • Element

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionCommunication Opt-Out
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... communicationProduct 0..1CodeableConceptApplies opt-out for a specific product
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-product
Binding: Engagement Product Value Set (extensible)
... conversationType 0..1CodeableConceptApplies opt-out for a specific conversation type
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/conversation-type
Binding: Engagement Conversation Type Value Set (extensible)
... communicationCareGap 0..1stringApplies opt-out for a specific care gap
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-care-gap
... statedReason 0..1CodeableConceptRecorded reason the recipient requested the opt-out
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/stated-reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://linuxforhealth.org/fhir/cdm/StructureDefinition/stated-reason"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Engagement Opt-Out Reason Value Set (extensible)
... effectivePeriod 0..1PeriodEffective period for the opt-out
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/effective-period
... url 1..1uri"http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-opt-out"

doco Documentation for this format

Differential View

This structure is derived from Extension

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionCommunication Opt-Out
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... communicationProduct 0..1CodeableConceptApplies opt-out for a specific product
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-product
Binding: Engagement Product Value Set (extensible)
... conversationType 0..1CodeableConceptApplies opt-out for a specific conversation type
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/conversation-type
Binding: Engagement Conversation Type Value Set (extensible)
... communicationCareGap 0..1stringApplies opt-out for a specific care gap
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-care-gap
... statedReason 0..1CodeableConceptRecorded reason the recipient requested the opt-out
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/stated-reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://linuxforhealth.org/fhir/cdm/StructureDefinition/stated-reason"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Engagement Opt-Out Reason Value Set (extensible)
... effectivePeriod 0..1PeriodEffective period for the opt-out
URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/effective-period
... url 1..1uri"http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-opt-out"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:statedReason.value[x]:valueCodeableConceptextensibleEngagementOptOutReasonValueSet (a valid code from Engagement Opt-Out Reason Codes)