LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions
| Active as of 2022-11-10 |
Definitions for the communication-opt-out extension.
| 1. Extension | |
| Definition | Opt-out patient for communications by product and/or mode Optional Extension Element - found in all resources. |
| 2. Extension.extension:communicationProduct | |
| SliceName | communicationProduct |
| Definition | Applies opt-out for a specific product |
| Control | 0..1 |
| Type | Extension(CommunicationProduct) (Extension Type: CodeableConcept) |
| 3. Extension.extension:communicationMode | |
| SliceName | communicationMode |
| Definition | Applies opt-out for specific mode of communication (phone | sms | email | mail | chat) |
| Control | 0..1 |
| Type | Extension(CommunicationMode) (Extension Type: CodeableConcept) |
| 4. Extension.extension:conversationType | |
| SliceName | conversationType |
| Definition | Applies opt-out for a specific conversation type |
| Control | 0..1 |
| Type | Extension(ConversationType) (Extension Type: CodeableConcept) |
| 5. Extension.extension:communicationCareGap | |
| SliceName | communicationCareGap |
| Definition | Applies opt-out for a specific care gap |
| Control | 0..1 |
| Type | Extension(CommunicationCareGap) (Extension Type: string) |
| 6. Extension.extension:statedReason | |
| SliceName | statedReason |
| Definition | Recorded reason the recipient requested the opt-out |
| Control | 0..1 |
| Type | Extension(StatedReason) (Extension Type: CodeableConcept) |
| 7. Extension.extension:statedReason.valueCodeableConcept | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Engagement Opt-Out Reason Value Set; other codes may be used where these codes are not suitable |
| 8. Extension.extension:effectivePeriod | |
| SliceName | effectivePeriod |
| Definition | Effective period for the opt-out |
| Control | 0..1 |
| Type | Extension(EffectivePeriod) (Extension Type: Period) |
| 9. Extension.url | |
| Fixed Value | http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-opt-out |
| 10. Extension.value[x] | |
| Control | 0..01 |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 1. Extension | |
| Definition | Opt-out patient for communications by product and/or mode Optional Extension Element - found in all resources. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Invariants | Defined on this element 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.extension:communicationProduct | |
| SliceName | communicationProduct |
| Definition | Applies opt-out for a specific product |
| Control | 0..1 |
| Type | Extension(CommunicationProduct) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element 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()) |
| 3. Extension.extension:communicationMode | |
| SliceName | communicationMode |
| Definition | Applies opt-out for specific mode of communication (phone | sms | email | mail | chat) |
| Control | 0..1 |
| Type | Extension(CommunicationMode) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element 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. Extension.extension:conversationType | |
| SliceName | conversationType |
| Definition | Applies opt-out for a specific conversation type |
| Control | 0..1 |
| Type | Extension(ConversationType) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element 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()) |
| 5. Extension.extension:communicationCareGap | |
| SliceName | communicationCareGap |
| Definition | Applies opt-out for a specific care gap |
| Control | 0..1 |
| Type | Extension(CommunicationCareGap) (Extension Type: string) |
| Invariants | Defined on this element 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()) |
| 6. Extension.extension:statedReason | |
| SliceName | statedReason |
| Definition | Recorded reason the recipient requested the opt-out |
| Control | 0..1 |
| Type | Extension(StatedReason) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element 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()) |
| 7. Extension.extension:statedReason.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. |
| Control | 0..0* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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. |
| Invariants | Defined on this element 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.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 8. Extension.extension:statedReason.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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. |
| Fixed Value | http://linuxforhealth.org/fhir/cdm/StructureDefinition/stated-reason |
| 9. Extension.extension:statedReason.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..1 |
| Type | Choice of: 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] |
| Invariants | Defined on this element 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.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
| 10. Extension.extension:statedReason.value[x]:valueCodeableConcept | |
| SliceName | valueCodeableConcept |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Engagement Opt-Out Reason Value Set; other codes may be used where these codes are not suitableFor codes, see (unbound) |
| Type | Choice of: 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] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 11. Extension.extension:effectivePeriod | |
| SliceName | effectivePeriod |
| Definition | Effective period for the opt-out |
| Control | 0..1 |
| Type | Extension(EffectivePeriod) (Extension Type: Period) |
| Invariants | Defined on this element 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()) |
| 12. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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. |
| Fixed Value | http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-opt-out |
| 13. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 1. Extension | |
| Definition | Opt-out patient for communications by product and/or mode |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 3. Extension.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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensionsuser content |
| 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. |
| Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. Extension.extension:communicationProduct | |
| SliceName | communicationProduct |
| Definition | Applies opt-out for a specific product |
| Control | 0..1 |
| Type | Extension(CommunicationProduct) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element 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()) |
| 5. Extension.extension:communicationMode | |
| SliceName | communicationMode |
| Definition | Applies opt-out for specific mode of communication (phone | sms | email | mail | chat) |
| Control | 0..1 |
| Type | Extension(CommunicationMode) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element 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()) |
| 6. Extension.extension:conversationType | |
| SliceName | conversationType |
| Definition | Applies opt-out for a specific conversation type |
| Control | 0..1 |
| Type | Extension(ConversationType) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element 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()) |
| 7. Extension.extension:communicationCareGap | |
| SliceName | communicationCareGap |
| Definition | Applies opt-out for a specific care gap |
| Control | 0..1 |
| Type | Extension(CommunicationCareGap) (Extension Type: string) |
| Invariants | Defined on this element 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. Extension.extension:statedReason | |
| SliceName | statedReason |
| Definition | Recorded reason the recipient requested the opt-out |
| Control | 0..1 |
| Type | Extension(StatedReason) (Extension Type: CodeableConcept) |
| Invariants | Defined on this element 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()) |
| 9. Extension.extension:statedReason.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 10. Extension.extension:statedReason.extension | |
| Definition | An Extension |
| Control | 0..0 |
| Type | Extension |
| Invariants | Defined on this element 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.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 11. Extension.extension:statedReason.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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. |
| Fixed Value | http://linuxforhealth.org/fhir/cdm/StructureDefinition/stated-reason |
| 12. Extension.extension:statedReason.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..1 |
| Type | CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element 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.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
| 13. Extension.extension:statedReason.value[x]:valueCodeableConcept | |
| SliceName | valueCodeableConcept |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Engagement Opt-Out Reason Value Set; other codes may be used where these codes are not suitable |
| Type | CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 14. Extension.extension:effectivePeriod | |
| SliceName | effectivePeriod |
| Definition | Effective period for the opt-out |
| Control | 0..1 |
| Type | Extension(EffectivePeriod) (Extension Type: Period) |
| Invariants | Defined on this element 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()) |
| 15. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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. |
| Fixed Value | http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-opt-out |
| 16. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |