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
| Official URL: http://v2.hl7.org/fhir/StructureDefinition/v2MessageStructureDefinition | Version: 1st draft | |||
| Draft as of 2023-10-23 | Computable Name: v2+ Message Structure Definition | |||
Message Structure Definition
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  v2MessageStructureDefinition | 0..* | Base | Base for all types and resources Instances of this logical model are not marked to be the target of a Reference | |
  code | Σ | 1..1 | code | code name of this message structure, eg. ADT_A01 Binding: hl7VS-messageStructure (required): Message Structure Code |
| title | Σ | 0..1 | string | human readable display name |
 description | 0..1 | Narrative | textual description of this message structure | |
| messageType | 1..1 | code | Binding: http://terminology.hl7.org/ValueSet/v2plus-vs-message-type (required) | |
| steward | 0..1 | code | Binding: steward (required): Steward for this Message Structure | |
| triggerEvents | 0..* | code | Binding: event (extensible): What are the associated triggering events? | |
 structure | 1..* | BackboneElement | detailed structure This repeating element order: The order of segmentEntry elements defines the structure of the HL7 V2 message. Order SHALL be preserved by all implementations. | |
 sequenceNumber | 1..1 | integer | ||
  Slices for segment | 1..* | choice of segment group, segment, or choice Slice: Unordered, Open by value:system | ||
   segment:SegmentGroup | 1..1 | group of segments | ||
  name | 1..1 | string | group of segments | |
 structure | 1..1 | BackboneElement | Nested Structure | |
| segment:IndividualSegment | 1..* | individual segments | ||
| code | 1..1 | string | code for individual segment | |
 segment:ChoiceGroup | 1..* | choice of segments | ||
| number | 1..1 | integer | number to identify this individual group | |
| name | 1..1 | string | groupname | |
| structure | 1..1 | BackboneElement | Nested Structure | |
| implement | 0..1 | code | This value indicates wheether this segment has to be implemented. The default value is empty, i.e. optional. Binding: v2plus-implement (required) | |
| minCardinality | 0..1 | integer | ||
| maxCardinality | 0..1 | integer | ||
 status | 0..1 | string | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2MessageStructureDefinition.code | required | Hl7VSMessageStructure |
| v2MessageStructureDefinition.messageType | required | http://terminology.hl7.org/ValueSet/v2plus-vs-message-type |
| v2MessageStructureDefinition.steward | required | steward |
| v2MessageStructureDefinition.triggerEvents | extensible | event |
| v2MessageStructureDefinition.structure.implement | required | v2plus-implement |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| v2MessageStructureDefinition | 0..* | Base | Base for all types and resources Instances of this logical model are not marked to be the target of a Reference | |
| code | Σ | 1..1 | code | code name of this message structure, eg. ADT_A01 Binding: hl7VS-messageStructure (required): Message Structure Code |
| title | Σ | 0..1 | string | human readable display name |
| description | 0..1 | Narrative | textual description of this message structure | |
| messageType | 1..1 | code | Binding: http://terminology.hl7.org/ValueSet/v2plus-vs-message-type (required) | |
| steward | 0..1 | code | Binding: steward (required): Steward for this Message Structure | |
| triggerEvents | 0..* | code | Binding: event (extensible): What are the associated triggering events? | |
| structure | 1..* | BackboneElement | detailed structure This repeating element order: The order of segmentEntry elements defines the structure of the HL7 V2 message. Order SHALL be preserved by all implementations. | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequenceNumber | 1..1 | integer | ||
| Slices for segment:SegmentGroup | 1..1 | group of segments Slice: Unordered, Open by value:system | ||
| segment:SegmentGroup:All Slices | Content/Rules for all slices | |||
 name | 1..1 | string | groupname | |
 structure | 1..1 | BackboneElement | Nested Structure | |
| segment:IndividualSegment | 1..* | individual segments | ||
| code | 1..1 | string | code for individual segment | |
| segment:ChoiceGroup | 1..* | choice of segments | ||
| number | 1..1 | integer | number to identify this individual group | |
| implement | 0..1 | code | This value indicates wheether this segment has to be implemented. The default value is empty, i.e. optional. Binding: v2plus-implement (required) | |
| minCardinality | 0..1 | integer | ||
| maxCardinality | 0..1 | integer | ||
| status | 0..1 | string | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2MessageStructureDefinition.code | required | Hl7VSMessageStructure |
| v2MessageStructureDefinition.messageType | required | http://terminology.hl7.org/ValueSet/v2plus-vs-message-type |
| v2MessageStructureDefinition.steward | required | steward |
| v2MessageStructureDefinition.triggerEvents | extensible | event |
| v2MessageStructureDefinition.structure.implement | required | v2plus-implement |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| v2MessageStructureDefinition | 0..* | Base | Base for all types and resources Instances of this logical model are not marked to be the target of a Reference | |
| code | Σ | 1..1 | code | code name of this message structure, eg. ADT_A01 Binding: hl7VS-messageStructure (required): Message Structure Code |
| title | Σ | 0..1 | string | human readable display name |
| description | 0..1 | Narrative | textual description of this message structure | |
| messageType | 1..1 | code | Binding: http://terminology.hl7.org/ValueSet/v2plus-vs-message-type (required) | |
| steward | 0..1 | code | Binding: steward (required): Steward for this Message Structure | |
| triggerEvents | 0..* | code | Binding: event (extensible): What are the associated triggering events? | |
| structure | 1..* | BackboneElement | detailed structure This repeating element order: The order of segmentEntry elements defines the structure of the HL7 V2 message. Order SHALL be preserved by all implementations. | |
| @id | 0..1 | id | Unique id for inter-element referencing | |
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequenceNumber | 1..1 | integer | ||
| Slices for segment:SegmentGroup | 1..1 | group of segments Slice: Unordered, Open by value:system | ||
| segment:SegmentGroup:All Slices | Content/Rules for all slices | |||
| name | 1..1 | string | groupname | |
| structure | 1..1 | BackboneElement | Nested Structure | |
| segment:IndividualSegment | 1..* | individual segments | ||
| code | 1..1 | string | code for individual segment | |
| segment:ChoiceGroup | 1..* | choice of segments | ||
| number | 1..1 | integer | number to identify this individual group | |
| implement | 0..1 | code | This value indicates wheether this segment has to be implemented. The default value is empty, i.e. optional. Binding: v2plus-implement (required) | |
| minCardinality | 0..1 | integer | ||
| maxCardinality | 0..1 | integer | ||
| status | 0..1 | string | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2MessageStructureDefinition.code | required | Hl7VSMessageStructure |
| v2MessageStructureDefinition.messageType | required | http://terminology.hl7.org/ValueSet/v2plus-vs-message-type |
| v2MessageStructureDefinition.steward | required | steward |
| v2MessageStructureDefinition.triggerEvents | extensible | event |
| v2MessageStructureDefinition.structure.implement | required | v2plus-implement |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| v2MessageStructureDefinition | 0..* | Base | Base for all types and resources Instances of this logical model are not marked to be the target of a Reference | |
| code | Σ | 1..1 | code | code name of this message structure, eg. ADT_A01 Binding: hl7VS-messageStructure (required): Message Structure Code |
| title | Σ | 0..1 | string | human readable display name |
| description | 0..1 | Narrative | textual description of this message structure | |
| messageType | 1..1 | code | Binding: http://terminology.hl7.org/ValueSet/v2plus-vs-message-type (required) | |
| steward | 0..1 | code | Binding: steward (required): Steward for this Message Structure | |
| triggerEvents | 0..* | code | Binding: event (extensible): What are the associated triggering events? | |
| structure | 1..* | BackboneElement | detailed structure This repeating element order: The order of segmentEntry elements defines the structure of the HL7 V2 message. Order SHALL be preserved by all implementations. | |
| sequenceNumber | 1..1 | integer | ||
| Slices for segment | 1..* | choice of segment group, segment, or choice Slice: Unordered, Open by value:system | ||
| segment:SegmentGroup | 1..1 | group of segments | ||
| name | 1..1 | string | group of segments | |
| structure | 1..1 | BackboneElement | Nested Structure | |
| segment:IndividualSegment | 1..* | individual segments | ||
| code | 1..1 | string | code for individual segment | |
| segment:ChoiceGroup | 1..* | choice of segments | ||
| number | 1..1 | integer | number to identify this individual group | |
| name | 1..1 | string | groupname | |
| structure | 1..1 | BackboneElement | Nested Structure | |
| implement | 0..1 | code | This value indicates wheether this segment has to be implemented. The default value is empty, i.e. optional. Binding: v2plus-implement (required) | |
| minCardinality | 0..1 | integer | ||
| maxCardinality | 0..1 | integer | ||
| status | 0..1 | string | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2MessageStructureDefinition.code | required | Hl7VSMessageStructure |
| v2MessageStructureDefinition.messageType | required | http://terminology.hl7.org/ValueSet/v2plus-vs-message-type |
| v2MessageStructureDefinition.steward | required | steward |
| v2MessageStructureDefinition.triggerEvents | extensible | event |
| v2MessageStructureDefinition.structure.implement | required | v2plus-implement |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| v2MessageStructureDefinition | 0..* | Base | Base for all types and resources Instances of this logical model are not marked to be the target of a Reference | |
| code | Σ | 1..1 | code | code name of this message structure, eg. ADT_A01 Binding: hl7VS-messageStructure (required): Message Structure Code |
| title | Σ | 0..1 | string | human readable display name |
| description | 0..1 | Narrative | textual description of this message structure | |
| messageType | 1..1 | code | Binding: http://terminology.hl7.org/ValueSet/v2plus-vs-message-type (required) | |
| steward | 0..1 | code | Binding: steward (required): Steward for this Message Structure | |
| triggerEvents | 0..* | code | Binding: event (extensible): What are the associated triggering events? | |
| structure | 1..* | BackboneElement | detailed structure This repeating element order: The order of segmentEntry elements defines the structure of the HL7 V2 message. Order SHALL be preserved by all implementations. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequenceNumber | 1..1 | integer | ||
| Slices for segment:SegmentGroup | 1..1 | group of segments Slice: Unordered, Open by value:system | ||
| segment:SegmentGroup:All Slices | Content/Rules for all slices | |||
| name | 1..1 | string | groupname | |
| structure | 1..1 | BackboneElement | Nested Structure | |
| segment:IndividualSegment | 1..* | individual segments | ||
| code | 1..1 | string | code for individual segment | |
| segment:ChoiceGroup | 1..* | choice of segments | ||
| number | 1..1 | integer | number to identify this individual group | |
| implement | 0..1 | code | This value indicates wheether this segment has to be implemented. The default value is empty, i.e. optional. Binding: v2plus-implement (required) | |
| minCardinality | 0..1 | integer | ||
| maxCardinality | 0..1 | integer | ||
| status | 0..1 | string | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2MessageStructureDefinition.code | required | Hl7VSMessageStructure |
| v2MessageStructureDefinition.messageType | required | http://terminology.hl7.org/ValueSet/v2plus-vs-message-type |
| v2MessageStructureDefinition.steward | required | steward |
| v2MessageStructureDefinition.triggerEvents | extensible | event |
| v2MessageStructureDefinition.structure.implement | required | v2plus-implement |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| v2MessageStructureDefinition | 0..* | Base | Base for all types and resources Instances of this logical model are not marked to be the target of a Reference | |
| code | Σ | 1..1 | code | code name of this message structure, eg. ADT_A01 Binding: hl7VS-messageStructure (required): Message Structure Code |
| title | Σ | 0..1 | string | human readable display name |
| description | 0..1 | Narrative | textual description of this message structure | |
| messageType | 1..1 | code | Binding: http://terminology.hl7.org/ValueSet/v2plus-vs-message-type (required) | |
| steward | 0..1 | code | Binding: steward (required): Steward for this Message Structure | |
| triggerEvents | 0..* | code | Binding: event (extensible): What are the associated triggering events? | |
| structure | 1..* | BackboneElement | detailed structure This repeating element order: The order of segmentEntry elements defines the structure of the HL7 V2 message. Order SHALL be preserved by all implementations. | |
| @id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequenceNumber | 1..1 | integer | ||
| Slices for segment:SegmentGroup | 1..1 | group of segments Slice: Unordered, Open by value:system | ||
| segment:SegmentGroup:All Slices | Content/Rules for all slices | |||
| name | 1..1 | string | groupname | |
| structure | 1..1 | BackboneElement | Nested Structure | |
| segment:IndividualSegment | 1..* | individual segments | ||
| code | 1..1 | string | code for individual segment | |
| segment:ChoiceGroup | 1..* | choice of segments | ||
| number | 1..1 | integer | number to identify this individual group | |
| implement | 0..1 | code | This value indicates wheether this segment has to be implemented. The default value is empty, i.e. optional. Binding: v2plus-implement (required) | |
| minCardinality | 0..1 | integer | ||
| maxCardinality | 0..1 | integer | ||
| status | 0..1 | string | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2MessageStructureDefinition.code | required | Hl7VSMessageStructure |
| v2MessageStructureDefinition.messageType | required | http://terminology.hl7.org/ValueSet/v2plus-vs-message-type |
| v2MessageStructureDefinition.steward | required | steward |
| v2MessageStructureDefinition.triggerEvents | extensible | event |
| v2MessageStructureDefinition.structure.implement | required | v2plus-implement |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |