ST: CharacterString (V3 Data Type) - Clinical Document Architecture v2.0.1-sd

Clinical Document Architecture
2.0.1-sd - release

This page is part of the CDA: Clinical Document Architecture (v2.0.1-sd: CDA 2.0 - Informative) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: ST: CharacterString (V3 Data Type)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/ST				Version: 2.0.1-sd
Active as of 2024-12-18				Computable Name: ST

The character string data type stands for text data, primarily intended for machine processing (e.g., sorting, querying, indexing, etc.) Used for names, symbols, and formal expressions.

Usage:

Derived from this Logical Model Profile: ADXP: CharacterString (V3 Data Type), ENXP: Entity Name Part (V3 Data Type) and SC: CharacterStringWithCode (V3 Data Type)
Use this Logical Model Profile: ClinicalDocument (CDA Class), Criterion (CDA Class), Material (CDA Class), Observation (CDA Class)... Show 2 more

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints
ST	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
xmlText		0..1	st	Allows for mixed text content
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
text-null	error	ST	xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText \| nullFlavor).count() = 1

Name	Flags	Card.	Type	Description & Constraints
ST	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
(Choice of one)		1..1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
xmlText		0..1	st	Allows for mixed text content
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ST.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
text-null	error	ST	xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText \| nullFlavor).count() = 1

Name	Flags	Card.	Type	Description & Constraints
ST	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
(Choice of one)		1..1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
xmlText		0..1	st	Allows for mixed text content
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ST.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
text-null	error	ST	xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText \| nullFlavor).count() = 1

This structure is derived from ANY

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints
ST	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
xmlText		0..1	st	Allows for mixed text content
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
text-null	error	ST	xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText \| nullFlavor).count() = 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ST	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
(Choice of one)		1..1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
xmlText		0..1	st	Allows for mixed text content
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ST.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
text-null	error	ST	xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText \| nullFlavor).count() = 1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ST	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
(Choice of one)		1..1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
xmlText		0..1	st	Allows for mixed text content
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ST.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
text-null	error	ST	xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText \| nullFlavor).count() = 1

This structure is derived from ANY

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

Other representations of profile: CSV, Excel

IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.1-sd based on FHIR 5.0.0. Generated 2024-12-18
Links: Table of Contents | QA Report | Version History external | | Propose a change