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/v2DataTypeDefinition | Version: 1st draft | |||
| Draft as of 2023-10-23 | Computable Name: v2 Data Type Definition | |||
Data Type 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 |
|---|---|---|---|---|
  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. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2DataTypeDefinition.component.implement | required | v2plus-implement |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | ||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2DataTypeDefinition.component.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 |
|---|---|---|---|---|
| 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 | ||
| @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 | |
| 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. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2DataTypeDefinition.component.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() |
This structure is derived from Base
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2DataTypeDefinition.component.implement | required | v2plus-implement |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | ||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2DataTypeDefinition.component.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 |
|---|---|---|---|---|
| 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 | ||
| @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 | |
| 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. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| v2DataTypeDefinition.component.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() |
This structure is derived from Base