v2+ Details
0.3.2 - Working Draft to present the concept ideas (FO)
v2+ Details
0.3.2 - Working Draft to present the concept ideas (FO)
v2+ Details - Local Development build (v0.3.2). See the Directory of published versions
| Draft as of 2023-10-23 |
Definitions for the v2SegmentDefinition logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. v2SegmentDefinition | |
| Short | This element defines the attributes for a specific segment. |
| Control | 0..* |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. v2SegmentDefinition.code | |
| Definition | This is the three letter code for the segment. |
| Short | This is the three letter code for the segment. |
| Control | 1..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. v2SegmentDefinition.title | |
| Short | This is a short display name for human reading. |
| Control | 1..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. v2SegmentDefinition.description | |
| Short | This a short description of this segment. |
| Control | 0..1 |
| Type | Narrative(Narrative) |
| 8. v2SegmentDefinition.withdrawn | |
| Short | This boolean value indicates whether this segment is still active and can be used. The default value is false. |
| Control | 0..1 |
| Type | boolean(boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Default Value | false |
| 10. v2SegmentDefinition.steward | |
| Short | Which WG is the steward for this segment. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from steward |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. v2SegmentDefinition.lastElementMayRepeat | |
| Short | This boolean value indicates whether the last element according to the field definition may repeat. The default value is false. |
| Control | 0..1 |
| Type | boolean(boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Default Value | false |
| 14. v2SegmentDefinition.field | |
| Control | 1..* |
| Type | BackboneElement |
| 16. v2SegmentDefinition.field.sequenceNumber | |
| Control | 1..1 |
| Type | positiveInt(positiveInt) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. v2SegmentDefinition.field.dataElement | |
| Control | 1..1 |
| Type | canonical(canonical)(v2+ Data Element Definition) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. v2SegmentDefinition.field.implement | |
| Short | This value indicates wheether this field has to be implemented. The default value is empty, i.e. optional. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from v2plus-implement |
| Type | code(code) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. v2SegmentDefinition.field.compatiblityFlag | |
| Control | 0..* |
| Binding | The codes SHALL be taken from segment-field-flags |
| Type | code(code) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. v2SegmentDefinition.field.condition | |
| Short | what is the condition if there is one? |
| Control | 0..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. v2SegmentDefinition.field.minCardinality | |
| Control | 0..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. v2SegmentDefinition.field.maxCardinality | |
| Control | 0..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. v2SegmentDefinition.field.conceptDomain | |
| Short | This element specifies the concept domain to which this data element is bound. |
| Control | 0..1 |
| Type | CodeableConcept |
| 32. v2SegmentDefinition.field.valueSet | |
| Short | Which value set is bound to this field. Overwrites the binding as provided by the data element definition. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
| 0. v2SegmentDefinition | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | This element defines the attributes for a specific segment.Base for all types and resources |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. v2SegmentDefinition.code | |
| Definition | This is the three letter code for the segment. |
| Short | This is the three letter code for the segment. |
| Control | 1..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. v2SegmentDefinition.title | |
| Short | This is a short display name for human reading. |
| Control | 1..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 6. v2SegmentDefinition.description | |
| Short | This a short description of this segment. |
| Control | 0..1 |
| Type | Narrative(Narrative) |
| 8. v2SegmentDefinition.withdrawn | |
| Short | This boolean value indicates whether this segment is still active and can be used. The default value is false. |
| Control | 0..1 |
| Type | boolean(boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Default Value | false |
| 10. v2SegmentDefinition.steward | |
| Short | Which WG is the steward for this segment. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from steward |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. v2SegmentDefinition.lastElementMayRepeat | |
| Short | This boolean value indicates whether the last element according to the field definition may repeat. The default value is false. |
| Control | 0..1 |
| Type | boolean(boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Default Value | false |
| 14. v2SegmentDefinition.field | |
| Control | 1..* |
| Type | BackboneElement |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. v2SegmentDefinition.field.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 18. v2SegmentDefinition.field.sequenceNumber | |
| Control | 1..1 |
| Type | positiveInt(positiveInt) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 20. v2SegmentDefinition.field.dataElement | |
| Control | 1..1 |
| Type | canonical(canonical)(v2+ Data Element Definition) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 22. v2SegmentDefinition.field.implement | |
| Short | This value indicates wheether this field has to be implemented. The default value is empty, i.e. optional. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from v2plus-implement |
| Type | code(code) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. v2SegmentDefinition.field.compatiblityFlag | |
| Control | 0..* |
| Binding | The codes SHALL be taken from segment-field-flags |
| Type | code(code) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. v2SegmentDefinition.field.condition | |
| Short | what is the condition if there is one? |
| Control | 0..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. v2SegmentDefinition.field.minCardinality | |
| Control | 0..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. v2SegmentDefinition.field.maxCardinality | |
| Control | 0..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. v2SegmentDefinition.field.conceptDomain | |
| Short | This element specifies the concept domain to which this data element is bound. |
| Control | 0..1 |
| Type | CodeableConcept |
| 34. v2SegmentDefinition.field.valueSet | |
| Short | Which value set is bound to this field. Overwrites the binding as provided by the data element definition. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
| 0. v2SegmentDefinition | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | This element defines the attributes for a specific segment. |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. v2SegmentDefinition.code | |
| Definition | This is the three letter code for the segment. |
| Short | This is the three letter code for the segment. |
| Control | 1..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. v2SegmentDefinition.title | |
| Short | This is a short display name for human reading. |
| Control | 1..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 6. v2SegmentDefinition.description | |
| Short | This a short description of this segment. |
| Control | 0..1 |
| Type | Narrative(Narrative) |
| 8. v2SegmentDefinition.withdrawn | |
| Short | This boolean value indicates whether this segment is still active and can be used. The default value is false. |
| Control | 0..1 |
| Type | boolean(boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Default Value | false |
| 10. v2SegmentDefinition.steward | |
| Short | Which WG is the steward for this segment. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from steward |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. v2SegmentDefinition.lastElementMayRepeat | |
| Short | This boolean value indicates whether the last element according to the field definition may repeat. The default value is false. |
| Control | 0..1 |
| Type | boolean(boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Default Value | false |
| 14. v2SegmentDefinition.field | |
| Control | 1..* |
| Type | BackboneElement |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. v2SegmentDefinition.field.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 18. v2SegmentDefinition.field.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 managable, 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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 v2SegmentDefinition.field.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 20. v2SegmentDefinition.field.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions. |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 22. v2SegmentDefinition.field.sequenceNumber | |
| Control | 1..1 |
| Type | positiveInt(positiveInt) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 24. v2SegmentDefinition.field.dataElement | |
| Control | 1..1 |
| Type | canonical(canonical)(v2+ Data Element Definition) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 26. v2SegmentDefinition.field.implement | |
| Short | This value indicates wheether this field has to be implemented. The default value is empty, i.e. optional. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from v2plus-implement |
| Type | code(code) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. v2SegmentDefinition.field.compatiblityFlag | |
| Control | 0..* |
| Binding | The codes SHALL be taken from segment-field-flags |
| Type | code(code) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. v2SegmentDefinition.field.condition | |
| Short | what is the condition if there is one? |
| Control | 0..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. v2SegmentDefinition.field.minCardinality | |
| Control | 0..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. v2SegmentDefinition.field.maxCardinality | |
| Control | 0..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. v2SegmentDefinition.field.conceptDomain | |
| Short | This element specifies the concept domain to which this data element is bound. |
| Control | 0..1 |
| Type | CodeableConcept |
| 38. v2SegmentDefinition.field.valueSet | |
| Short | Which value set is bound to this field. Overwrites the binding as provided by the data element definition. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |