v2SegmentDefinition
type: StructureDefinition
node role: treeRoot
id:
  v: v2SegmentDefinition
text:
  status:
    v: extensions
  div: Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> 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. <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
url:
  v: http://v2.hl7.org/fhir/StructureDefinition/v2SegmentDefinition
version:
  v: 1st draft
name:
  v: v2+ Segment Definition
title:
  v: v2+ Segment Definition
status:
  v: draft
date:
  v: 2023-10-23T14:45:10+02:00
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: v2SegmentDefinition
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Base
  link: http://hl7.org/fhir/StructureDefinition/Base
derivation:
  v: specialization
snapshot:
  element:
    id:
      v: v2SegmentDefinition
    path:
      v: v2SegmentDefinition
    short:
      v: This element defines the attributes for a specific segment.
    definition:
      v: Base definition for all types defined in FHIR type system.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: v2SegmentDefinition.code
    path:
      v: v2SegmentDefinition.code
    short:
      v: This is the three letter code for the segment.
    definition:
      v: This is the three letter code for the segment.
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: v2SegmentDefinition.code
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: string
      profile:
        v: http://hl7.org/fhir/StructureDefinition/string
        link: http://hl7.org/fhir/StructureDefinition/string
    is summary:
      v: true
  element:
    id:
      v: v2SegmentDefinition.title
    path:
      v: v2SegmentDefinition.title
    short:
      v: This is a short display name for human reading.
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: v2SegmentDefinition.title
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: string
      profile:
        v: http://hl7.org/fhir/StructureDefinition/string
        link: http://hl7.org/fhir/StructureDefinition/string
    is summary:
      v: true
  element:
    id:
      v: v2SegmentDefinition.description
    path:
      v: v2SegmentDefinition.description
    short:
      v: This a short description of this segment.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: v2SegmentDefinition.description
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: Narrative
      profile:
        v: http://hl7.org/fhir/StructureDefinition/Narrative
        link: http://hl7.org/fhir/StructureDefinition/Narrative
  element:
    id:
      v: v2SegmentDefinition.withdrawn
    path:
      v: v2SegmentDefinition.withdrawn
    short:
      v: This boolean value indicates whether this segment is still active and can be used. The default value is false.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: v2SegmentDefinition.withdrawn
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: boolean
      profile:
        v: http://hl7.org/fhir/StructureDefinition/boolean
        link: http://hl7.org/fhir/StructureDefinition/boolean
    default value:
      v: false
  element:
    id:
      v: v2SegmentDefinition.steward
    path:
      v: v2SegmentDefinition.steward
    short:
      v: Which WG is the steward for this segment.
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: v2SegmentDefinition.steward
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: code
    binding:
      strength:
        v: required
      value set:
        v: steward
  element:
    short:
      v: This boolean value indicates whether the last element according to the field definition may repeat. The default value is false.
    min:
      v: 0

v: 1

min:
  v: 0
max:
  v: 1

code:
  v: boolean
profile:
  v: http://hl7.org/fhir/StructureDefinition/boolean
  link: http://hl7.org/fhir/StructureDefinition/boolean

v: false

id:
  v: v2SegmentDefinition.field
path:
  v: v2SegmentDefinition.field
min:
  v: 1
max:
  v: *
base:
  path:
    v: v2SegmentDefinition.field
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is summary:
  v: true

id:
  v: v2SegmentDefinition.field.id
path:
  v: v2SegmentDefinition.field.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: id
  code:
    v: http://hl7.org/fhirpath/System.String
condition:
  v: ele-1
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: v2SegmentDefinition.field.extension
path:
  v: v2SegmentDefinition.field.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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).
comment:
  v: 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.
requirements:
  v: 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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

min:
  v: 1
max:
  v: 1
base:
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: positiveInt
  profile:
    v: http://hl7.org/fhir/StructureDefinition/positiveInt
    link: http://hl7.org/fhir/StructureDefinition/positiveInt
is summary:
  v: true

id:
  v: v2SegmentDefinition.field.dataElement
path:
  v: v2SegmentDefinition.field.dataElement
min:
  v: 1
max:
  v: 1
base:
  path:
    v: v2SegmentDefinition.field.dataElement
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: canonical
  profile:
    v: http://hl7.org/fhir/StructureDefinition/canonical
    link: http://hl7.org/fhir/StructureDefinition/canonical
  target profile:
    v: http://v2.hl7.org/fhir/StructureDefinition/v2DataElementDefinition
    link: http://v2.hl7.org/fhir/StructureDefinition/v2DataElementDefinition
is summary:
  v: true

id:
  v: v2SegmentDefinition.field.implement
path:
  v: v2SegmentDefinition.field.implement
short:
  v: This value indicates wheether this field has to be implemented. The default value is empty, i.e. optional.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: v2SegmentDefinition.field.implement
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
  profile:
    v: http://hl7.org/fhir/StructureDefinition/code
    link: http://hl7.org/fhir/StructureDefinition/code
binding:
  strength:
    v: required
  value set:
    v: v2plus-implement

min:
  v: 0
max:
  v: *
base:
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: code
  profile:
    v: http://hl7.org/fhir/StructureDefinition/code
    link: http://hl7.org/fhir/StructureDefinition/code
binding:
  strength:
    v: required
  value set:
    v: segment-field-flags

id:
  v: v2SegmentDefinition.field.condition
path:
  v: v2SegmentDefinition.field.condition
short:
  v: what is the condition if there is one?
min:
  v: 0
max:
  v: 1
base:
  path:
    v: v2SegmentDefinition.field.condition
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
  profile:
    v: http://hl7.org/fhir/StructureDefinition/string
    link: http://hl7.org/fhir/StructureDefinition/string

min:
  v: 0
max:
  v: 1
base:
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: integer
  profile:
    v: http://hl7.org/fhir/StructureDefinition/integer
    link: http://hl7.org/fhir/StructureDefinition/integer

min:
  v: 0
max:
  v: 1
base:
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: integer
  profile:
    v: http://hl7.org/fhir/StructureDefinition/integer
    link: http://hl7.org/fhir/StructureDefinition/integer

id:
  v: v2SegmentDefinition.field.conceptDomain
path:
  v: v2SegmentDefinition.field.conceptDomain
short:
  v: This element specifies the concept domain to which this data element is bound.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: v2SegmentDefinition.field.conceptDomain
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept

id:
  v: v2SegmentDefinition.field.valueSet
path:
  v: v2SegmentDefinition.field.valueSet
short:
  v: Which value set is bound to this field. Overwrites the binding as provided by the data element definition.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: v2SegmentDefinition.field.valueSet
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string

element:
  id:
    v: v2SegmentDefinition
  path:
    v: v2SegmentDefinition
  short:
    v: This element defines the attributes for a specific segment.
  min:
    v: 0
  max:
    v: *
element:
  id:
    v: v2SegmentDefinition.code
  path:
    v: v2SegmentDefinition.code
  short:
    v: This is the three letter code for the segment.
  definition:
    v: This is the three letter code for the segment.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
    profile:
      v: http://hl7.org/fhir/StructureDefinition/string
      link: http://hl7.org/fhir/StructureDefinition/string
  is summary:
    v: true
element:
  id:
    v: v2SegmentDefinition.title
  path:
    v: v2SegmentDefinition.title
  short:
    v: This is a short display name for human reading.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
    profile:
      v: http://hl7.org/fhir/StructureDefinition/string
      link: http://hl7.org/fhir/StructureDefinition/string
  is summary:
    v: true
element:
  id:
    v: v2SegmentDefinition.description
  path:
    v: v2SegmentDefinition.description
  short:
    v: This a short description of this segment.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Narrative
    profile:
      v: http://hl7.org/fhir/StructureDefinition/Narrative
      link: http://hl7.org/fhir/StructureDefinition/Narrative
element:
  id:
    v: v2SegmentDefinition.withdrawn
  path:
    v: v2SegmentDefinition.withdrawn
  short:
    v: This boolean value indicates whether this segment is still active and can be used. The default value is false.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: boolean
    profile:
      v: http://hl7.org/fhir/StructureDefinition/boolean
      link: http://hl7.org/fhir/StructureDefinition/boolean
  default value:
    v: false
element:
  id:
    v: v2SegmentDefinition.steward
  path:
    v: v2SegmentDefinition.steward
  short:
    v: Which WG is the steward for this segment.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: code
  binding:
    strength:
      v: required
    value set:
      v: steward
element:
  short:
    v: This boolean value indicates whether the last element according to the field definition may repeat. The default value is false.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: boolean
    profile:
      v: http://hl7.org/fhir/StructureDefinition/boolean
      link: http://hl7.org/fhir/StructureDefinition/boolean
  default value:
    v: false
element:
  id:
    v: v2SegmentDefinition.field
  path:
    v: v2SegmentDefinition.field
  min:
    v: 1
  max:
    v: *
  type:
    code:
      v: BackboneElement
  is summary:
    v: true
element:
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: positiveInt
    profile:
      v: http://hl7.org/fhir/StructureDefinition/positiveInt
      link: http://hl7.org/fhir/StructureDefinition/positiveInt
  is summary:
    v: true
element:
  id:
    v: v2SegmentDefinition.field.dataElement
  path:
    v: v2SegmentDefinition.field.dataElement
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: canonical
    profile:
      v: http://hl7.org/fhir/StructureDefinition/canonical
      link: http://hl7.org/fhir/StructureDefinition/canonical
    target profile:
      v: http://v2.hl7.org/fhir/StructureDefinition/v2DataElementDefinition
      link: http://v2.hl7.org/fhir/StructureDefinition/v2DataElementDefinition
  is summary:
    v: true
element:
  id:
    v: v2SegmentDefinition.field.implement
  path:
    v: v2SegmentDefinition.field.implement
  short:
    v: This value indicates wheether this field has to be implemented. The default value is empty, i.e. optional.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: code
    profile:
      v: http://hl7.org/fhir/StructureDefinition/code
      link: http://hl7.org/fhir/StructureDefinition/code
  binding:
    strength:
      v: required
    value set:
      v: v2plus-implement
element:
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: code
    profile:
      v: http://hl7.org/fhir/StructureDefinition/code
      link: http://hl7.org/fhir/StructureDefinition/code

strength:
  v: required
value set:
  v: segment-field-flags

id:
  v: v2SegmentDefinition.field.condition
path:
  v: v2SegmentDefinition.field.condition
short:
  v: what is the condition if there is one?
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
  profile:
    v: http://hl7.org/fhir/StructureDefinition/string
    link: http://hl7.org/fhir/StructureDefinition/string

min:
  v: 0
max:
  v: 1
type:
  code:
    v: integer
  profile:
    v: http://hl7.org/fhir/StructureDefinition/integer
    link: http://hl7.org/fhir/StructureDefinition/integer

min:
  v: 0
max:
  v: 1
type:
  code:
    v: integer
  profile:
    v: http://hl7.org/fhir/StructureDefinition/integer
    link: http://hl7.org/fhir/StructureDefinition/integer

id:
  v: v2SegmentDefinition.field.conceptDomain
path:
  v: v2SegmentDefinition.field.conceptDomain
short:
  v: This element specifies the concept domain to which this data element is bound.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CodeableConcept

id:
  v: v2SegmentDefinition.field.valueSet
path:
  v: v2SegmentDefinition.field.valueSet
short:
  v: Which value set is bound to this field. Overwrites the binding as provided by the data element definition.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string