Common UML Documentation

Element

Common
Class List

"A list is a curated collection of resources." - HL7 FHIR, List

Attributes
«TS» PointInTime	date	"The date that the list was prepared." - HL7 FHIR, List.date
«CS» Code	emptyReason	"If the list is empty, why the list is empty." - HL7 FHIR, List.emptyReason
«EntryPoint» EncounterEvent	encounter
Entry	entry	"Entries in this list." - HL7 FHIR, List.entry
«II» Id	identifier	"Identifier for the List assigned for business purposes outside the context of FHIR." - HL7 FHIR, List.identifier
«CS» Code	kind	"This code defines the purpose of the list - why it was created." - HL7 FHIR, List.code
«CS» Code	mode	"How this 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, List.mode
Annotation	note	"Comments that apply to the overall list." - HL7 FHIR, List.note
«CS» Code	orderedBy	"What order applies to the items in the list." - HL7 FHIR, List.orderedBy
«ANY» Any	source	"The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list." - HL7 FHIR, List.source
«CS» Code	status	"Indicates the current state of this list." - HL7 FHIR, List.status
«ANY» Any	subject	"The common subject (or patient) of the resources that are in the list if there is one." - HL7 FHIR, List.subject
String	title	"A label for the list assigned by the author." - HL7 FHIR, List.title

Properties:

Alias
Classifier Behavior
Is Abstract	false
Is Active	false
Is Leaf	false
Keywords
Name	List
Name Expression
Namespace	Common
Owned Template Signature
Owner	Common
Owning Template Parameter
Package	Common
Qualified Name	FHIM::Common::List
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

date

Public «TS» PointInTime date

"The date that the list was prepared." - HL7 FHIR, List.date

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	List
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	date
Name Expression
Namespace	List
Opposite
Owner	List
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::List::date
Stereotype
Template Parameter
Type	«TS» PointInTime
Upper	1
Upper Value	(1)
Visibility	Public

emptyReason

Public «CS» Code emptyReason

"If the list is empty, why the list is empty." - HL7 FHIR, List.emptyReason

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	List
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	List
Opposite
Owner	List
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::List::emptyReason
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

encounter

Public «EntryPoint» EncounterEvent encounter

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	List
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	encounter
Name Expression
Namespace	List
Opposite
Owner	List
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::List::encounter
Stereotype
Template Parameter
Type	«EntryPoint» EncounterEvent
Upper	1
Upper Value	(1)
Visibility	Public

entry

Public Entry entry

"Entries in this list." - HL7 FHIR, List.entry

Constraints:

Properties:

Aggregation	None
Alias
Association	list_entry
Association End
Class	List
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	List
Opposite
Owner	List
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::List::entry
Stereotype
Template Parameter
Type	Entry
Upper	*
Upper Value	(*)
Visibility	Public

identifier

Public «II» Id identifier

"Identifier for the List assigned for business purposes outside the context of FHIR." - HL7 FHIR, List.identifier

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	List
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	identifier
Name Expression
Namespace	List
Opposite
Owner	List
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::List::identifier
Stereotype
Template Parameter
Type	«II» Id
Upper	*
Upper Value	(*)
Visibility	Public

kind

Public «CS» Code kind

"This code defines the purpose of the list - why it was created." - HL7 FHIR, List.code

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	List
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	List
Opposite
Owner	List
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::List::kind
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

mode

Public «CS» Code mode

"How this 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, List.mode

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	List
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	List
Opposite
Owner	List
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::List::mode
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

note

Public Annotation note

"Comments that apply to the overall list." - HL7 FHIR, List.note

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	List
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	note
Name Expression
Namespace	List
Opposite
Owner	List
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::List::note
Stereotype
Template Parameter
Type	Annotation
Upper	*
Upper Value	(*)
Visibility	Public

orderedBy

Public «CS» Code orderedBy

"What order applies to the items in the list." - HL7 FHIR, List.orderedBy

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	List
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	List
Opposite
Owner	List
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::List::orderedBy
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

source

Public «ANY» Any source

"The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list." - HL7 FHIR, List.source

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	List
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	source
Name Expression
Namespace	List
Opposite
Owner	List
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::List::source
Stereotype
Template Parameter
Type	«ANY» Any
Upper	1
Upper Value	(1)
Visibility	Public

status

Public «CS» Code status

"Indicates the current state of this list." - HL7 FHIR, List.status

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	List
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	1
Lower Value	(1)
Multiplicity	1
Name	status
Name Expression
Namespace	List
Opposite
Owner	List
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::List::status
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

subject

Public «ANY» Any subject

"The common subject (or patient) of the resources that are in the list if there is one." - HL7 FHIR, List.subject

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	List
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	List
Opposite
Owner	List
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::List::subject
Stereotype
Template Parameter
Type	«ANY» Any
Upper	1
Upper Value	(1)
Visibility	Public

title

Public String title

"A label for the list assigned by the author." - HL7 FHIR, List.title

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	List
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	List
Opposite
Owner	List
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Common::List::title
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value	(1)
Visibility	Public

Overview

Top

Package

Element

Common UML Documentation

Summary:AttributesProperties

Detail:Attributes