Common
Class List

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

Attributes
«TS» PointInTime date date

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

«CS» Code emptyReason emptyReason

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

«EntryPoint» EncounterEvent encounter encounter
Entry entry entry

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

«II» Id identifier identifier

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

«CS» Code kind kind

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

«CS» Code mode 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 note

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

«CS» Code orderedBy orderedBy

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

«ANY» Any source 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 status

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

«ANY» Any subject subject

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

String title title

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


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameList
Name Expression
NamespaceCommon
Owned Template Signature
OwnerCommon
Owning Template Parameter
PackageCommon
Qualified NameFHIM::Common::List
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 date
Public «TS» PointInTime date

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassList
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namedate
Name Expression
NamespaceList
Opposite
OwnerList
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::List::date
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 emptyReason
Public «CS» Code emptyReason

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassList
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameemptyReason
Name Expression
NamespaceList
Opposite
OwnerList
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::List::emptyReason
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 encounter
Public «EntryPoint» EncounterEvent encounter
Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassList
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameencounter
Name Expression
NamespaceList
Opposite
OwnerList
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::List::encounter
Stereotype
Template Parameter
Type«EntryPoint» EncounterEvent
Upper1
Upper Value(1)
VisibilityPublic


 entry
Public Entry entry

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

Constraints:
Properties:

AggregationNone
Alias
Associationlist_entry
Association End
ClassList
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameentry
Name Expression
NamespaceList
Opposite
OwnerList
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::List::entry
Stereotype
Template Parameter
TypeEntry
Upper*
Upper Value(*)
VisibilityPublic


 identifier
Public «II» Id identifier

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassList
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameidentifier
Name Expression
NamespaceList
Opposite
OwnerList
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::List::identifier
Stereotype
Template Parameter
Type«II» Id
Upper*
Upper Value(*)
VisibilityPublic


 kind
Public «CS» Code kind

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassList
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namekind
Name Expression
NamespaceList
Opposite
OwnerList
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::List::kind
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassList
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namemode
Name Expression
NamespaceList
Opposite
OwnerList
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::List::mode
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 note
Public Annotation note

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassList
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namenote
Name Expression
NamespaceList
Opposite
OwnerList
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::List::note
Stereotype
Template Parameter
TypeAnnotation
Upper*
Upper Value(*)
VisibilityPublic


 orderedBy
Public «CS» Code orderedBy

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassList
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameorderedBy
Name Expression
NamespaceList
Opposite
OwnerList
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::List::orderedBy
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassList
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namesource
Name Expression
NamespaceList
Opposite
OwnerList
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::List::source
Stereotype
Template Parameter
Type«ANY» Any
Upper1
Upper Value(1)
VisibilityPublic


 status
Public «CS» Code status

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassList
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namestatus
Name Expression
NamespaceList
Opposite
OwnerList
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::List::status
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassList
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namesubject
Name Expression
NamespaceList
Opposite
OwnerList
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::List::subject
Stereotype
Template Parameter
Type«ANY» Any
Upper1
Upper Value(1)
VisibilityPublic


 title
Public String title

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassList
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nametitle
Name Expression
NamespaceList
Opposite
OwnerList
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::List::title
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic