CH Core (R4)
4.0.0-ballot - ballot
CH Core (R4)
4.0.0-ballot - ballot
This page is part of the CH Core (R4) (v4.0.0-ballot: STU Ballot 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Active as of 2023-06-27 |
Definitions for the ch-ext-ech-46-emailcategory extension.
Guidance on how to interpret the contents of this table can be found here.
| 1. Extension | |
| 2. Extension.extension | |
| Control | 0..0* |
| 3. Extension.url | |
| Fixed Value | http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory |
| 4. Extension.value[x] | |
| Control | 10..1 |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Slicing | This element introduces a set of slices on Extension.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 5. Extension.value[x]:valueCodeableConcept | |
| SliceName | valueCodeableConcept |
| Control | 1..1 |
| Binding | The codes SHALL be taken from eCH-0046 Email Category; 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] |
| 6. Extension.value[x]:valueCodeableConcept.coding | |
| Control | 0..? |
| 7. Extension.value[x]:valueCodeableConcept.text | |
| Control | 0..? |
Guidance on how to interpret the contents of this table can be found here.
| 1. Extension | |||
| Definition | An Extension 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 | |||
| 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 | ||
| Summary | false | ||
| 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. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||
| 3. 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. | ||
| Summary | false | ||
| 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://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory | ||
| 4. Extension.value[x] | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Control | 10..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] | ||
| Summary | false | ||
| 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.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||
| 5. Extension.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 | 10..1 | ||
| Binding | The codes SHALL be taken from eCH-0046 Email Category; 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] | ||
| Summary | false | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
| 6. Extension.value[x]:valueCodeableConcept.coding | |||
| Definition | A reference to a code defined by a terminology system. | ||
| Control | 0..* | ||
| Type | Coding | ||
| Summary | true | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
| 7. Extension.value[x]:valueCodeableConcept.text | |||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
| Control | 0..1 | ||
| Type | string | ||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
| Obligations |
| ||
| Summary | true | ||
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||
| Invariants | Defined on this element 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.
| 1. Extension | |||
| Definition | An Extension | ||
| 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. | ||
| Summary | false | ||
| 3. Extension.extension | |||
| Definition | An Extension | ||
| Control | 0..0 | ||
| Type | Extension | ||
| Summary | false | ||
| 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.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. | ||
| Summary | false | ||
| 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://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory | ||
| 5. Extension.value[x] | |||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Control | 1..1 | ||
| Type | CodeableConcept | ||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||
| Summary | false | ||
| 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.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||
| 6. Extension.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 | 1..1 | ||
| Binding | The codes SHALL be taken from eCH-0046 Email Category; 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] | ||
| Summary | false | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
| 7. Extension.value[x]:valueCodeableConcept.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. | ||
| Summary | false | ||
| 8. Extension.value[x]:valueCodeableConcept.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 | ||
| Summary | false | ||
| 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.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||
| 9. Extension.value[x]:valueCodeableConcept.coding | |||
| Definition | A reference to a code defined by a terminology system. | ||
| Control | 0..* | ||
| Type | Coding | ||
| Summary | true | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
| 10. Extension.value[x]:valueCodeableConcept.text | |||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
| Control | 0..1 | ||
| Type | string | ||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
| Obligations |
| ||
| Summary | true | ||
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||