| ClinicalDocument UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
"Document sections can nest, can override context propagated from the header..., and can contain narrative and CDA entries." HL7 CDA, ClinicalDocument Section"The root of the sections that make up the composition." HL7 FHIR, Composition.section
Attributes | ||
PractitionerParticipation | author |
"The author participant, can be ascribed to a CDA section, where it overrides the value(s) propagated from the CDA header." HL7 CDA, Section.author"Identifies who is responsible for the information in this section, not necessarily who typed it in." HL7 FHIR, Composition.section.author |
«CS» Code | confidentiality |
"A value for Section.confidentialityCode overrides the value propagated from StructuredBody. See CDA Context (§ 4.4 ) for more details." HL7 CDA, Section.confidentialityCode |
«CS» Code | emptyReason |
"If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason." - HL7 FHIR, Composition.section.emptyReason |
ClinicalStatement | entry |
"The relationship between a section and its entries is encoded in the intervening entry Act Relationship...." - HL7 CDA, section.entry"A reference to the actual resource from which the narrative in the section is derived." - HL7 FHIR, Composition.section.entryNote that in FHIR, this is a reference to any resource, in FHIM, this is a pointer to a clinical statement |
«II» Id | identifier |
"The unique instance identifier of a particular document section." HL7 CDA, Section.id |
PractitionerParticipation | informant |
"The informant participant, can be ascribed to a CDA section where it overrides the value(s) propagated from the CDA header." - HL7 CDA, section.informant |
«CS» Code | kind |
"The code specifying the particular kind of section (e.g. Chief Complaint, Review of Systems, Assessment). The value set is drawn from LOINC, and has a CWE coding strength." HL7 CDA, Section.code"A code identifying the kind of content contained within the section. This must be consistent with the section title." HL7 FHIR, Composition.section.code |
«CS» Code | language |
"Specifies the human language of character data (whether they be in contents or attribute values). The values of the attribute are language identifiers as defined by the IETF RFC 3066." HL7 CDA, Section.languageCode |
«CS» Code | mode |
"How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted." HL7 FHIR, Composition.section.mode |
«CS» Code | orderedBy |
"Specifies the order applied to the items in the section entries." HL7 FHIR, Composition.section.orderedBy |
Subject | subject |
"The subject participant represents the primary target of the entries recorded in the document. Most of the time the subject is the same as the recordTarget, but need not be, for instance when the subject is a fetus observed in an obstetrical ultrasound. The subject participant can be ascribed to a CDA section or a CDA entry. It propagates to nested components, unless overridden. The subject of a document is presumed to be the patient." - HL7 CDA, section.subject |
String | text |
"Used to store narrative to be rendered. Also referred to as the CDA Narrative Block." HL7 CDA, Section.text"A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative." HL7 FHIR, Composition.section.text |
String | title |
"Represents the label of a section. If valued, it is to be rendered as part of the narrative content of the clinical document body." HL7 CDA, Section.title"The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents." HL7 FHIR, Composition.section.title |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | ClinicalDocumentSection |
Name Expression | |
Namespace | ClinicalDocument |
Owned Template Signature | |
Owner | ClinicalDocument |
Owning Template Parameter | |
Package | ClinicalDocument |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public PractitionerParticipation author
"The author participant, can be ascribed to a CDA section, where it overrides the value(s) propagated from the CDA header." HL7 CDA, Section.author"Identifies who is responsible for the information in this section, not necessarily who typed it in." HL7 FHIR, Composition.section.author
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocumentSection |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | author |
Name Expression | |
Namespace | ClinicalDocumentSection |
Opposite | |
Owner | ClinicalDocumentSection |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection::author |
Stereotype | |
Template Parameter | |
Type | PractitionerParticipation |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code confidentiality
"A value for Section.confidentialityCode overrides the value propagated from StructuredBody. See CDA Context (§ 4.4 ) for more details." HL7 CDA, Section.confidentialityCode
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocumentSection |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | confidentiality |
Name Expression | |
Namespace | ClinicalDocumentSection |
Opposite | |
Owner | ClinicalDocumentSection |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection::confidentiality |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code emptyReason
"If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason." - HL7 FHIR, Composition.section.emptyReason
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocumentSection |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | emptyReason |
Name Expression | |
Namespace | ClinicalDocumentSection |
Opposite | |
Owner | ClinicalDocumentSection |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection::emptyReason |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public ClinicalStatement entry
"The relationship between a section and its entries is encoded in the intervening entry Act Relationship...." - HL7 CDA, section.entry"A reference to the actual resource from which the narrative in the section is derived." - HL7 FHIR, Composition.section.entryNote that in FHIR, this is a reference to any resource, in FHIM, this is a pointer to a clinical statement
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocumentSection |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | entry |
Name Expression | |
Namespace | ClinicalDocumentSection |
Opposite | |
Owner | ClinicalDocumentSection |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection::entry |
Stereotype | |
Template Parameter | |
Type | ClinicalStatement |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «II» Id identifier
"The unique instance identifier of a particular document section." HL7 CDA, Section.id
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocumentSection |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | identifier |
Name Expression | |
Namespace | ClinicalDocumentSection |
Opposite | |
Owner | ClinicalDocumentSection |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public PractitionerParticipation informant
"The informant participant, can be ascribed to a CDA section where it overrides the value(s) propagated from the CDA header." - HL7 CDA, section.informant
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocumentSection |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | informant |
Name Expression | |
Namespace | ClinicalDocumentSection |
Opposite | |
Owner | ClinicalDocumentSection |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection::informant |
Stereotype | |
Template Parameter | |
Type | PractitionerParticipation |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code kind
"The code specifying the particular kind of section (e.g. Chief Complaint, Review of Systems, Assessment). The value set is drawn from LOINC, and has a CWE coding strength." HL7 CDA, Section.code"A code identifying the kind of content contained within the section. This must be consistent with the section title." HL7 FHIR, Composition.section.code
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocumentSection |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | kind |
Name Expression | |
Namespace | ClinicalDocumentSection |
Opposite | |
Owner | ClinicalDocumentSection |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection::kind |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code language
"Specifies the human language of character data (whether they be in contents or attribute values). The values of the attribute are language identifiers as defined by the IETF RFC 3066." HL7 CDA, Section.languageCode
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocumentSection |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | language |
Name Expression | |
Namespace | ClinicalDocumentSection |
Opposite | |
Owner | ClinicalDocumentSection |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection::language |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code mode
"How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted." HL7 FHIR, Composition.section.mode
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocumentSection |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | mode |
Name Expression | |
Namespace | ClinicalDocumentSection |
Opposite | |
Owner | ClinicalDocumentSection |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection::mode |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code orderedBy
"Specifies the order applied to the items in the section entries." HL7 FHIR, Composition.section.orderedBy
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocumentSection |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | orderedBy |
Name Expression | |
Namespace | ClinicalDocumentSection |
Opposite | |
Owner | ClinicalDocumentSection |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection::orderedBy |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Subject subject
"The subject participant represents the primary target of the entries recorded in the document. Most of the time the subject is the same as the recordTarget, but need not be, for instance when the subject is a fetus observed in an obstetrical ultrasound. The subject participant can be ascribed to a CDA section or a CDA entry. It propagates to nested components, unless overridden. The subject of a document is presumed to be the patient." - HL7 CDA, section.subject
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocumentSection |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | subject |
Name Expression | |
Namespace | ClinicalDocumentSection |
Opposite | |
Owner | ClinicalDocumentSection |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection::subject |
Stereotype | |
Template Parameter | |
Type | Subject |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String text
"Used to store narrative to be rendered. Also referred to as the CDA Narrative Block." HL7 CDA, Section.text"A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative." HL7 FHIR, Composition.section.text
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocumentSection |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | text |
Name Expression | |
Namespace | ClinicalDocumentSection |
Opposite | |
Owner | ClinicalDocumentSection |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection::text |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String title
"Represents the label of a section. If valued, it is to be rendered as part of the narrative content of the clinical document body." HL7 CDA, Section.title"The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents." HL7 FHIR, Composition.section.title
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocumentSection |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | title |
Name Expression | |
Namespace | ClinicalDocumentSection |
Opposite | |
Owner | ClinicalDocumentSection |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocumentSection::title |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| ClinicalDocument UML Documentation |
Summary:AttributesProperties | Detail:Attributes |