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/v2SegmentDefinition | Version: 1st draft | |||
| Draft as of 2023-10-23 | Computable Name: v2+ Segment 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 |
|---|---|---|---|---|
  v2SegmentDefinition | 0..* | Base | This element defines the attributes for a specific segment. Instances of this logical model are not marked to be the target of a Reference | |
  code | Σ | 1..1 | string | This is the three letter code for the segment. |
| title | Σ | 1..1 | string | This is a short display name for human reading. |
 description | 0..1 | Narrative | This a short description of this segment. | |
| withdrawn | 0..1 | boolean | This boolean value indicates whether this segment is still active and can be used. The default value is false. | |
| steward | 1..1 | code | Which WG is the steward for this segment. Binding: steward (required) | |
| lastElementMayRepeat | 0..1 | boolean | This boolean value indicates whether the last element according to the field definition may repeat. The default value is false. | |
 field | Σ | 1..* | BackboneElement | |
 sequenceNumber | Σ | 1..1 | positiveInt | |
| dataElement | Σ | 1..1 | canonical(v2+ Data Element Definition) | |
| implement | 0..1 | code | This value indicates wheether this field has to be implemented. The default value is empty, i.e. optional. Binding: v2plus-implement (required) | |
| compatiblityFlag | 0..* | code | Binding: segment-field-flags (required) | |
| condition | 0..1 | string | what is the condition if there is one? | |
| minCardinality | 0..1 | integer | ||
| maxCardinality | 0..1 | integer | ||
| conceptDomain | 0..1 | CodeableConcept | This element specifies the concept domain to which this data element is bound. | |
 valueSet | 0..1 | string | Which value set is bound to this field. Overwrites the binding as provided by the data element definition. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2SegmentDefinition.steward | required | steward |
| v2SegmentDefinition.field.implement | required | v2plus-implement |
| v2SegmentDefinition.field.compatiblityFlag | required | segment-field-flags |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| v2SegmentDefinition | 0..* | Base | This element defines the attributes for a specific segment. Instances of this logical model are not marked to be the target of a Reference | |
| code | Σ | 1..1 | string | This is the three letter code for the segment. |
| title | Σ | 1..1 | string | This is a short display name for human reading. |
| description | 0..1 | Narrative | This a short description of this segment. | |
| withdrawn | 0..1 | boolean | This boolean value indicates whether this segment is still active and can be used. The default value is false. | |
| steward | 1..1 | code | Which WG is the steward for this segment. Binding: steward (required) | |
| lastElementMayRepeat | 0..1 | boolean | This boolean value indicates whether the last element according to the field definition may repeat. The default value is false. | |
| field | Σ | 1..* | BackboneElement | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequenceNumber | Σ | 1..1 | positiveInt | |
| dataElement | Σ | 1..1 | canonical(v2+ Data Element Definition) | |
| implement | 0..1 | code | This value indicates wheether this field has to be implemented. The default value is empty, i.e. optional. Binding: v2plus-implement (required) | |
| compatiblityFlag | 0..* | code | Binding: segment-field-flags (required) | |
| condition | 0..1 | string | what is the condition if there is one? | |
| minCardinality | 0..1 | integer | ||
| maxCardinality | 0..1 | integer | ||
| conceptDomain | 0..1 | CodeableConcept | This element specifies the concept domain to which this data element is bound. | |
| valueSet | 0..1 | string | Which value set is bound to this field. Overwrites the binding as provided by the data element definition. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2SegmentDefinition.steward | required | steward |
| v2SegmentDefinition.field.implement | required | v2plus-implement |
| v2SegmentDefinition.field.compatiblityFlag | required | segment-field-flags |
| 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 |
|---|---|---|---|---|
| v2SegmentDefinition | 0..* | Base | This element defines the attributes for a specific segment. Instances of this logical model are not marked to be the target of a Reference | |
| code | Σ | 1..1 | string | This is the three letter code for the segment. |
| title | Σ | 1..1 | string | This is a short display name for human reading. |
| description | 0..1 | Narrative | This a short description of this segment. | |
| withdrawn | 0..1 | boolean | This boolean value indicates whether this segment is still active and can be used. The default value is false. | |
| steward | 1..1 | code | Which WG is the steward for this segment. Binding: steward (required) | |
| lastElementMayRepeat | 0..1 | boolean | This boolean value indicates whether the last element according to the field definition may repeat. The default value is false. | |
| field | Σ | 1..* | BackboneElement | |
| @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 | positiveInt | |
| dataElement | Σ | 1..1 | canonical(v2+ Data Element Definition) | |
| implement | 0..1 | code | This value indicates wheether this field has to be implemented. The default value is empty, i.e. optional. Binding: v2plus-implement (required) | |
| compatiblityFlag | 0..* | code | Binding: segment-field-flags (required) | |
| condition | 0..1 | string | what is the condition if there is one? | |
| minCardinality | 0..1 | integer | ||
| maxCardinality | 0..1 | integer | ||
| conceptDomain | 0..1 | CodeableConcept | This element specifies the concept domain to which this data element is bound. | |
| valueSet | 0..1 | string | Which value set is bound to this field. Overwrites the binding as provided by the data element definition. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2SegmentDefinition.steward | required | steward |
| v2SegmentDefinition.field.implement | required | v2plus-implement |
| v2SegmentDefinition.field.compatiblityFlag | required | segment-field-flags |
| 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() |
This structure is derived from Base
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| v2SegmentDefinition | 0..* | Base | This element defines the attributes for a specific segment. Instances of this logical model are not marked to be the target of a Reference | |
| code | Σ | 1..1 | string | This is the three letter code for the segment. |
| title | Σ | 1..1 | string | This is a short display name for human reading. |
| description | 0..1 | Narrative | This a short description of this segment. | |
| withdrawn | 0..1 | boolean | This boolean value indicates whether this segment is still active and can be used. The default value is false. | |
| steward | 1..1 | code | Which WG is the steward for this segment. Binding: steward (required) | |
| lastElementMayRepeat | 0..1 | boolean | This boolean value indicates whether the last element according to the field definition may repeat. The default value is false. | |
| field | Σ | 1..* | BackboneElement | |
| sequenceNumber | Σ | 1..1 | positiveInt | |
| dataElement | Σ | 1..1 | canonical(v2+ Data Element Definition) | |
| implement | 0..1 | code | This value indicates wheether this field has to be implemented. The default value is empty, i.e. optional. Binding: v2plus-implement (required) | |
| compatiblityFlag | 0..* | code | Binding: segment-field-flags (required) | |
| condition | 0..1 | string | what is the condition if there is one? | |
| minCardinality | 0..1 | integer | ||
| maxCardinality | 0..1 | integer | ||
| conceptDomain | 0..1 | CodeableConcept | This element specifies the concept domain to which this data element is bound. | |
| valueSet | 0..1 | string | Which value set is bound to this field. Overwrites the binding as provided by the data element definition. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2SegmentDefinition.steward | required | steward |
| v2SegmentDefinition.field.implement | required | v2plus-implement |
| v2SegmentDefinition.field.compatiblityFlag | required | segment-field-flags |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| v2SegmentDefinition | 0..* | Base | This element defines the attributes for a specific segment. Instances of this logical model are not marked to be the target of a Reference | |
| code | Σ | 1..1 | string | This is the three letter code for the segment. |
| title | Σ | 1..1 | string | This is a short display name for human reading. |
| description | 0..1 | Narrative | This a short description of this segment. | |
| withdrawn | 0..1 | boolean | This boolean value indicates whether this segment is still active and can be used. The default value is false. | |
| steward | 1..1 | code | Which WG is the steward for this segment. Binding: steward (required) | |
| lastElementMayRepeat | 0..1 | boolean | This boolean value indicates whether the last element according to the field definition may repeat. The default value is false. | |
| field | Σ | 1..* | BackboneElement | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| sequenceNumber | Σ | 1..1 | positiveInt | |
| dataElement | Σ | 1..1 | canonical(v2+ Data Element Definition) | |
| implement | 0..1 | code | This value indicates wheether this field has to be implemented. The default value is empty, i.e. optional. Binding: v2plus-implement (required) | |
| compatiblityFlag | 0..* | code | Binding: segment-field-flags (required) | |
| condition | 0..1 | string | what is the condition if there is one? | |
| minCardinality | 0..1 | integer | ||
| maxCardinality | 0..1 | integer | ||
| conceptDomain | 0..1 | CodeableConcept | This element specifies the concept domain to which this data element is bound. | |
| valueSet | 0..1 | string | Which value set is bound to this field. Overwrites the binding as provided by the data element definition. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2SegmentDefinition.steward | required | steward |
| v2SegmentDefinition.field.implement | required | v2plus-implement |
| v2SegmentDefinition.field.compatiblityFlag | required | segment-field-flags |
| 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 |
|---|---|---|---|---|
| v2SegmentDefinition | 0..* | Base | This element defines the attributes for a specific segment. Instances of this logical model are not marked to be the target of a Reference | |
| code | Σ | 1..1 | string | This is the three letter code for the segment. |
| title | Σ | 1..1 | string | This is a short display name for human reading. |
| description | 0..1 | Narrative | This a short description of this segment. | |
| withdrawn | 0..1 | boolean | This boolean value indicates whether this segment is still active and can be used. The default value is false. | |
| steward | 1..1 | code | Which WG is the steward for this segment. Binding: steward (required) | |
| lastElementMayRepeat | 0..1 | boolean | This boolean value indicates whether the last element according to the field definition may repeat. The default value is false. | |
| field | Σ | 1..* | BackboneElement | |
| @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 | positiveInt | |
| dataElement | Σ | 1..1 | canonical(v2+ Data Element Definition) | |
| implement | 0..1 | code | This value indicates wheether this field has to be implemented. The default value is empty, i.e. optional. Binding: v2plus-implement (required) | |
| compatiblityFlag | 0..* | code | Binding: segment-field-flags (required) | |
| condition | 0..1 | string | what is the condition if there is one? | |
| minCardinality | 0..1 | integer | ||
| maxCardinality | 0..1 | integer | ||
| conceptDomain | 0..1 | CodeableConcept | This element specifies the concept domain to which this data element is bound. | |
| valueSet | 0..1 | string | Which value set is bound to this field. Overwrites the binding as provided by the data element definition. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2SegmentDefinition.steward | required | steward |
| v2SegmentDefinition.field.implement | required | v2plus-implement |
| v2SegmentDefinition.field.compatiblityFlag | required | segment-field-flags |
| 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() |
This structure is derived from Base