v2DataTypeDefinition
type: StructureDefinition
node role: treeRoot
id:
  v: v2DataTypeDefinition
text:
  status:
    v: extensions
  div: Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> v2DataTypeDefinition 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 string This is the two or three letter code for the data type. title Σ 1..1 string This is a short human readable text for this data type. description 0..1 Narrative withdrawn 1..1 boolean completeExample 0..* Narrative component 1..* BackboneElement sequenceNumber Σ 1..1 positiveInt element[x] Σ 1..1 string Either a simple datatype, or a complext one as a reference. definition 0..1 Narrative implement 0..1 CodeableConcept Binding: v2plus-implement (required) minLength 0..1 integer maxLength 0..1 integer confLength 0..1 integer mayTruncate 0..1 boolean indicates whether this information can be truncated. Default value is false. exampleValue 0..* string comments 0..* string usageNotes 0..* string requirements 0..* string binding 0..1 canonical(ValueSet) Bound value set mayRepeat 0..1 boolean indicates that this field may repeat if defined as such, and if occuring as last. Default value is false. <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
url:
  v: http://v2.hl7.org/fhir/StructureDefinition/v2DataTypeDefinition
version:
  v: 1st draft
name:
  v: v2 Data Type Definition
title:
  v: v2 Data Type Definition
status:
  v: draft
date:
  v: 2023-10-23T14:45:10+02:00
description:
  v: Data Type Definition
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: v2DataTypeDefinition
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Base
  link: http://hl7.org/fhir/StructureDefinition/Base
derivation:
  v: specialization
snapshot:
  element:
    id:
      v: v2DataTypeDefinition
    path:
      v: v2DataTypeDefinition
    short:
      v: Base for all types and resources
    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: v2DataTypeDefinition.code
    path:
      v: v2DataTypeDefinition.code
    short:
      v: This is the two or three letter code for the data type.
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: v2DataTypeDefinition.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: v2DataTypeDefinition.title
    path:
      v: v2DataTypeDefinition.title
    short:
      v: This is a short human readable text for this data type.
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: v2DataTypeDefinition.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: v2DataTypeDefinition.description
    path:
      v: v2DataTypeDefinition.description
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: v2DataTypeDefinition.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: v2DataTypeDefinition.withdrawn
    path:
      v: v2DataTypeDefinition.withdrawn
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: v2DataTypeDefinition.withdrawn
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: boolean
      profile:
        v: http://hl7.org/fhir/StructureDefinition/boolean
        link: http://hl7.org/fhir/StructureDefinition/boolean
  element:
    id:
      v: v2DataTypeDefinition.completeExample
    path:
      v: v2DataTypeDefinition.completeExample
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: v2DataTypeDefinition.completeExample
      min:
        v: 0
      max:
        v: *
    type:
      code:
        v: Narrative
      profile:
        v: http://hl7.org/fhir/StructureDefinition/Narrative
        link: http://hl7.org/fhir/StructureDefinition/Narrative
  element:
    id:
      v: v2DataTypeDefinition.component
    path:
      v: v2DataTypeDefinition.component
    min:
      v: 1
    max:
      v: *
    base:
      path:
        v: v2DataTypeDefinition.component
      min:
        v: 1
      max:
        v: *

code:
  v: BackboneElement

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

id:
  v: v2DataTypeDefinition.component.id
path:
  v: v2DataTypeDefinition.component.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

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

short:
  v: Either a simple datatype, or a complext one as a reference.
min:
  v: 1
max:
  v: 1
base:
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
is summary:
  v: true

min:
  v: 0
max:
  v: 1
base:
  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

min:
  v: 0
max:
  v: 1
base:
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
binding:
  strength:
    v: required
  value set:
    v: v2plus-implement

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

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

short:
  v: indicates whether this information can be truncated. Default value is false.
min:
  v: 0
max:
  v: 1
base:
  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

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

id:
  v: v2DataTypeDefinition.component.comments
path:
  v: v2DataTypeDefinition.component.comments
min:
  v: 0
max:
  v: *
base:
  path:
    v: v2DataTypeDefinition.component.comments
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
  profile:
    v: http://hl7.org/fhir/StructureDefinition/string
    link: http://hl7.org/fhir/StructureDefinition/string

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

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

id:
  v: v2DataTypeDefinition.component.binding
path:
  v: v2DataTypeDefinition.component.binding
short:
  v: Bound value set
min:
  v: 0
max:
  v: 1
base:
  path:
    v: v2DataTypeDefinition.component.binding
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: canonical
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/ValueSet
    link: http://hl7.org/fhir/StructureDefinition/ValueSet

short:
  v: indicates that this field may repeat if defined as such, and if occuring as last. Default value is false.
min:
  v: 0
max:
  v: 1
base:
  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

element:
  id:
    v: v2DataTypeDefinition
  path:
    v: v2DataTypeDefinition
element:
  id:
    v: v2DataTypeDefinition.code
  path:
    v: v2DataTypeDefinition.code
  short:
    v: This is the two or three letter code for the data type.
  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: v2DataTypeDefinition.title
  path:
    v: v2DataTypeDefinition.title
  short:
    v: This is a short human readable text for this data type.
  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: v2DataTypeDefinition.description
  path:
    v: v2DataTypeDefinition.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: v2DataTypeDefinition.withdrawn
  path:
    v: v2DataTypeDefinition.withdrawn
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: boolean
    profile:
      v: http://hl7.org/fhir/StructureDefinition/boolean
      link: http://hl7.org/fhir/StructureDefinition/boolean
element:
  id:
    v: v2DataTypeDefinition.completeExample
  path:
    v: v2DataTypeDefinition.completeExample
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Narrative
    profile:
      v: http://hl7.org/fhir/StructureDefinition/Narrative
      link: http://hl7.org/fhir/StructureDefinition/Narrative
element:
  id:
    v: v2DataTypeDefinition.component
  path:
    v: v2DataTypeDefinition.component
  min:
    v: 1
  max:
    v: *
  type:
    code:
      v: BackboneElement
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:
  short:
    v: Either a simple datatype, or a complext one as a reference.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
  is summary:
    v: true
element:
  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:
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: CodeableConcept
  binding:
    strength:
      v: required
    value set:
      v: v2plus-implement
element:
  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
element:
  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
element:
  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
element:
  short:
    v: indicates whether this information can be truncated. 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
element:
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: string

id:
  v: v2DataTypeDefinition.component.comments
path:
  v: v2DataTypeDefinition.component.comments
min:
  v: 0
max:
  v: *
type:
  code:
    v: string
  profile:
    v: http://hl7.org/fhir/StructureDefinition/string
    link: http://hl7.org/fhir/StructureDefinition/string

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

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

id:
  v: v2DataTypeDefinition.component.binding
path:
  v: v2DataTypeDefinition.component.binding
short:
  v: Bound value set
min:
  v: 0
max:
  v: 1
type:
  code:
    v: canonical
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/ValueSet
    link: http://hl7.org/fhir/StructureDefinition/ValueSet

short:
  v: indicates that this field may repeat if defined as such, and if occuring as last. 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