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 v2MessageStructureDefinition logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. v2MessageStructureDefinition | |
| Control | 0..* |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. v2MessageStructureDefinition.code | |
| Short | code name of this message structure, eg. ADT_A01 |
| Control | 1..1 |
| Binding | The codes SHALL be taken from hl7VS-messageStructure: Message Structure Code |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. v2MessageStructureDefinition.title | |
| Short | human readable display name |
| Control | 0..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. v2MessageStructureDefinition.description | |
| Short | textual description of this message structure |
| Control | 0..1 |
| Type | Narrative(Narrative) |
| 8. v2MessageStructureDefinition.messageType | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2plus-vs-message-type |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. v2MessageStructureDefinition.steward | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from steward: Steward for this Message Structure |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. v2MessageStructureDefinition.triggerEvents | |
| Control | 0..* |
| Binding | Unless not suitable, these codes SHALL be taken from event: What are the associated triggering events? |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. v2MessageStructureDefinition.structure | |
| Short | detailed structure |
| Control | 1..* |
| Type | BackboneElement |
| 16. v2MessageStructureDefinition.structure.sequenceNumber | |
| Control | 1..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. v2MessageStructureDefinition.structure.segment | |
| Short | choice of segment group, segment, or choice |
| Control | 1..* |
| Slicing | This element introduces a set of slices on v2MessageStructureDefinition.structure.segment. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 20. v2MessageStructureDefinition.structure.segment:SegmentGroup | |
| Slice Name | SegmentGroup |
| Short | group of segments |
| Control | 1..1 |
| 22. v2MessageStructureDefinition.structure.segment:SegmentGroup.name | |
| Short | group of segments |
| Control | 1..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. v2MessageStructureDefinition.structure.segment:SegmentGroup.structure | |
| Short | Nested Structure |
| Control | 1..1 |
| Type | BackboneElement |
| 26. v2MessageStructureDefinition.structure.segment:IndividualSegment | |
| Slice Name | IndividualSegment |
| Short | individual segments |
| Control | 1..* |
| 28. v2MessageStructureDefinition.structure.segment:IndividualSegment.code | |
| Short | code for individual segment |
| Control | 1..1 |
| Type | code(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. v2MessageStructureDefinition.structure.segment:ChoiceGroup | |
| Slice Name | ChoiceGroup |
| Short | choice of segments |
| Control | 1..* |
| 32. v2MessageStructureDefinition.structure.segment:ChoiceGroup.number | |
| Short | number to identify this individual group |
| Control | 1..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. v2MessageStructureDefinition.structure.segment:ChoiceGroup.name | |
| Short | groupname |
| Control | 1..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. v2MessageStructureDefinition.structure.segment:ChoiceGroup.structure | |
| Control | 1..1 |
| Type | BackboneElement |
| 38. v2MessageStructureDefinition.structure.implement | |
| Short | This value indicates wheether this segment 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 |
| 40. v2MessageStructureDefinition.structure.minCardinality | |
| Control | 0..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 42. v2MessageStructureDefinition.structure.maxCardinality | |
| Control | 0..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 44. v2MessageStructureDefinition.structure.status | |
| Definition | Specify the concept domain if it is a coded element |
| Control | 0..1 |
| Type | string(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. v2MessageStructureDefinition | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | 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. v2MessageStructureDefinition.code | |
| Short | code name of this message structure, eg. ADT_A01 |
| Control | 1..1 |
| Binding | The codes SHALL be taken from hl7VS-messageStructure: Message Structure Code |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. v2MessageStructureDefinition.title | |
| Short | human readable display name |
| Control | 0..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 6. v2MessageStructureDefinition.description | |
| Short | textual description of this message structure |
| Control | 0..1 |
| Type | Narrative(Narrative) |
| 8. v2MessageStructureDefinition.messageType | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2plus-vs-message-type |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. v2MessageStructureDefinition.steward | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from steward: Steward for this Message Structure |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. v2MessageStructureDefinition.triggerEvents | |
| Control | 0..* |
| Binding | Unless not suitable, these codes SHALL be taken from event: What are the associated triggering events? |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. v2MessageStructureDefinition.structure | |
| Short | detailed structure |
| Control | 1..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. v2MessageStructureDefinition.structure.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. v2MessageStructureDefinition.structure.sequenceNumber | |
| Control | 1..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. v2MessageStructureDefinition.structure.segment:SegmentGroup | |
| Slice Name | SegmentGroup |
| Short | group of segments |
| Control | 1..1 |
| Slicing | This element introduces a set of slices on v2MessageStructureDefinition.structure.segment. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 22. v2MessageStructureDefinition.structure.segment:SegmentGroup.name | |
| Short | groupname |
| Control | 1..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. v2MessageStructureDefinition.structure.segment:SegmentGroup.structure | |
| Short | Nested Structure |
| Control | 1..1 |
| Type | BackboneElement |
| 26. v2MessageStructureDefinition.structure.segment:IndividualSegment | |
| Slice Name | IndividualSegment |
| Short | individual segments |
| Control | 1..* |
| 28. v2MessageStructureDefinition.structure.segment:IndividualSegment.code | |
| Short | code for individual segment |
| Control | 1..1 |
| Type | code(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. v2MessageStructureDefinition.structure.segment:ChoiceGroup | |
| Slice Name | ChoiceGroup |
| Short | choice of segments |
| Control | 1..* |
| 32. v2MessageStructureDefinition.structure.segment:ChoiceGroup.number | |
| Short | number to identify this individual group |
| Control | 1..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. v2MessageStructureDefinition.structure.implement | |
| Short | This value indicates wheether this segment 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 |
| 36. v2MessageStructureDefinition.structure.minCardinality | |
| Control | 0..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. v2MessageStructureDefinition.structure.maxCardinality | |
| Control | 0..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. v2MessageStructureDefinition.structure.status | |
| Definition | Specify the concept domain if it is a coded element |
| Control | 0..1 |
| Type | string(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. v2MessageStructureDefinition | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | 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. v2MessageStructureDefinition.code | |
| Short | code name of this message structure, eg. ADT_A01 |
| Control | 1..1 |
| Binding | The codes SHALL be taken from hl7VS-messageStructure: Message Structure Code |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. v2MessageStructureDefinition.title | |
| Short | human readable display name |
| Control | 0..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 6. v2MessageStructureDefinition.description | |
| Short | textual description of this message structure |
| Control | 0..1 |
| Type | Narrative(Narrative) |
| 8. v2MessageStructureDefinition.messageType | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2plus-vs-message-type |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. v2MessageStructureDefinition.steward | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from steward: Steward for this Message Structure |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. v2MessageStructureDefinition.triggerEvents | |
| Control | 0..* |
| Binding | Unless not suitable, these codes SHALL be taken from event: What are the associated triggering events? |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. v2MessageStructureDefinition.structure | |
| Short | detailed structure |
| Control | 1..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. v2MessageStructureDefinition.structure.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. v2MessageStructureDefinition.structure.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 v2MessageStructureDefinition.structure.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 20. v2MessageStructureDefinition.structure.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. v2MessageStructureDefinition.structure.sequenceNumber | |
| Control | 1..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. v2MessageStructureDefinition.structure.segment:SegmentGroup | |
| Slice Name | SegmentGroup |
| Short | group of segments |
| Control | 1..1 |
| Slicing | This element introduces a set of slices on v2MessageStructureDefinition.structure.segment. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 26. v2MessageStructureDefinition.structure.segment:SegmentGroup.name | |
| Short | groupname |
| Control | 1..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. v2MessageStructureDefinition.structure.segment:SegmentGroup.structure | |
| Short | Nested Structure |
| Control | 1..1 |
| Type | BackboneElement |
| 30. v2MessageStructureDefinition.structure.segment:IndividualSegment | |
| Slice Name | IndividualSegment |
| Short | individual segments |
| Control | 1..* |
| 32. v2MessageStructureDefinition.structure.segment:IndividualSegment.code | |
| Short | code for individual segment |
| Control | 1..1 |
| Type | code(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. v2MessageStructureDefinition.structure.segment:ChoiceGroup | |
| Slice Name | ChoiceGroup |
| Short | choice of segments |
| Control | 1..* |
| 36. v2MessageStructureDefinition.structure.segment:ChoiceGroup.number | |
| Short | number to identify this individual group |
| Control | 1..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. v2MessageStructureDefinition.structure.implement | |
| Short | This value indicates wheether this segment 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 |
| 40. v2MessageStructureDefinition.structure.minCardinality | |
| Control | 0..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 42. v2MessageStructureDefinition.structure.maxCardinality | |
| Control | 0..1 |
| Type | integer(integer) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 44. v2MessageStructureDefinition.structure.status | |
| Definition | Specify the concept domain if it is a coded element |
| Control | 0..1 |
| Type | string(string) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |