|
List
|
|
Definition
|
A
set
of
information
summarized
from
a
list
of
other
resources.
A set of information summarized from a list of other resources.
|
|
Control
|
1..1
|
Alternate
Names
Alternate Names
|
Collection;
WorkingList;
Organizer
Collection; WorkingList; Organizer
|
|
Invariants
|
Defined
on
this
element
Defined on this element
lst-1
:
A
list
can
only
have
an
emptyReason
if
it
is
empty
(xpath:
not(exists(f:emptyReason)
and
exists(f:entry)))
: A list can only have an emptyReason if it is empty (
expression
: emptyReason.empty() or entry.empty(), xpath: not(exists(f:emptyReason) and exists(f:entry)))
lst-2
:
The
deleted
flag
can
only
be
used
if
the
mode
of
the
list
is
"changes"
(xpath:
(f:mode/@value
=
'changes')
or
not(exists(f:entry/f:deleted)))
: The deleted flag can only be used if the mode of the list is "changes" (
expression
: mode = 'changes' or entry.deleted.empty(), xpath: (f:mode/@value = 'changes') or not(exists(f:entry/f:deleted)))
|
To
Do
To Do
|
RIM
harmonization
proposal
to
move
LIST
under
GROUPER
RIM
harmonization
proposal
to
allow
organizers
to
group
roles
as
well
as
acts.
RIM harmonization proposal to move LIST under GROUPER RIM harmonization proposal to allow organizers to group roles as well as acts.
|
|
List.identifier
|
|
Definition
|
Identifier
for
the
List
assigned
for
business
purposes
outside
the
context
of
FHIR.
Identifier for the List assigned for business purposes outside the context of FHIR.
|
|
Note
|
This
is
a
business
identifer,
not
a
resource
identifier
(see
This is a business identifer, not a resource identifier (see
discussion
)
|
|
Control
|
0..*
|
|
Type
|
Identifier
|
List.title
List.status
|
|
Definition
|
A
label
for
the
list
assigned
by
the
author.
Indicates the current state of this list.
|
|
Control
|
0..1
1..1
|
|
Binding
|
ListStatus:
The current state of the list
(
Required
)
|
|
Type
|
string
code
|
Requirements
Is Modifier
|
Allows
customization
beyond
just
the
code
identifying
the
kind
of
list.
true
|
|
Summary
|
true
|
List.code
List.mode
|
|
Definition
|
This
code
defines
the
purpose
of
the
list
-
why
it
was
created.
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.
|
|
Control
|
0..1
1..1
|
|
Binding
|
Example
Use
Codes
for
List:
What
the
purpose
of
a
list
is
(
Example
ListMode:
The processing mode that applies to this list
(
Required
)
|
|
Type
|
CodeableConcept
code
|
|
Is Modifier
|
true
|
|
Requirements
|
Lists
often
contain
subsets
of
resources
rather
than
an
exhaustive
list.
The
code
identifies
what
type
of
subset
is
included.
Lists are used in various ways, and it must be known in what way it is safe to use them.
|
|
Summary
|
true
|
Comments
If
there
is
no
code,
the
purpose
of
the
list
is
implied
where
it
is
used,
such
as
in
a
document
section
using
Document.section.code.
List.subject
List.title
|
|
Definition
|
The
common
subject
(or
patient)
of
the
resources
that
are
in
the
list,
if
there
is
one.
A label for the list assigned by the author.
|
|
Control
|
0..1
|
|
Type
|
Reference
(
Patient
|
Group
|
Device
|
Location
string
)
|
|
Requirements
|
The
primary
purpose
of
listing
the
subject
explicitly
is
to
help
with
finding
the
right
list.
Allows customization beyond just the code identifying the kind of list.
|
|
Summary
|
true
|
Comments
Some
purely
arbitrary
lists
do
not
have
a
common
subject,
so
this
is
optional.
List.source
List.code
|
|
Definition
|
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.
This code defines the purpose of the list - why it was created.
|
|
Control
|
0..1
|
Type
Binding
|
Reference
(
Practitioner
|
Patient
|
Device
Example Use Codes for List:
What the purpose of a list is
(
Example
)
|
Requirements
Type
|
Allows
follow-up
as
well
as
context.
CodeableConcept
|
Alternate
Names
Requirements
|
Author
Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included.
|
|
Summary
|
true
|
|
Comments
|
The
primary
source
is
the
entity
that
made
the
decisions
what
items
are
in
the
list.
This
may
be
software
or
user.
If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code.
|
List.encounter
List.subject
|
|
Definition
|
The
encounter
that
is
the
context
in
which
this
list
was
created.
The common subject (or patient) of the resources that are in the list, if there is one.
|
|
Control
|
0..1
|
|
Type
|
Reference
(
Encounter
Patient
|
Group
|
Device
|
Location
)
|
List.status
Definition
Requirements
|
Indicates
the
current
state
of
this
list.
The primary purpose of listing the subject explicitly is to help with finding the right list.
|
Control
Summary
|
1..1
true
|
Binding
Comments
|
ListStatus:
The
current
state
of
the
list
(
Required
)
Some purely arbitrary lists do not have a common subject, so this is optional.
|
Type
List.encounter
|
|
Definition
|
code
The encounter that is the context in which this list was created.
|
Is
Modifier
Control
|
true
0..1
|
Summary
Type
|
true
Reference
(
Encounter
)
|
|
List.date
|
|
Definition
|
The
date
that
the
list
was
prepared.
The date that the list was prepared.
|
|
Control
|
0..1
|
|
Type
|
dateTime
|
|
Requirements
|
Identifies
how
current
the
list
is
which
affects
relevance.
Identifies how current the list is which affects relevance.
|
|
Summary
|
true
|
|
Comments
|
The
actual
important
date
is
the
date
of
currency
of
the
resources
that
were
summarized,
but
it
is
usually
assumed
that
these
are
current
when
the
preparation
occurs.
The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs.
|
List.orderedBy
List.source
|
|
Definition
|
What
order
applies
to
the
items
in
the
list.
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.
|
|
Control
|
0..1
|
Binding
Type
|
List
Order
Codes:
What
order
applies
to
the
items
in
a
list
Reference
(
Preferred
Practitioner
|
Patient
|
Device
)
|
Type
Requirements
|
CodeableConcept
Allows follow-up as well as context.
|
|
Alternate Names
|
Requirements
Author
|
Important
for
presentation
and
rendering.
Lists
may
be
sorted
to
place
more
important
information
first
or
to
group
related
entries.
Summary
|
true
|
|
Comments
|
Applications
SHOULD
render
ordered
lists
in
the
order
provided,
but
MAY
allow
users
to
re-order
based
on
their
own
preferences
as
well.
If
there
is
no
order
specified,
the
order
is
unknown,
though
there
may
still
be
some
order.
The primary source is the entity that made the decisions what items are in the list. This may be software or user.
|
List.mode
List.orderedBy
|
|
Definition
|
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.
What order applies to the items in the list.
|
|
Control
|
1..1
0..1
|
|
Binding
|
ListMode:
The
processing
mode
that
applies
to
this
list
(
Required
List Order Codes:
What order applies to the items in a list
(
Preferred
)
|
|
Type
|
code
Is
Modifier
CodeableConcept
|
true
|
Requirements
|
Lists
are
used
in
various
ways,
and
it
must
be
known
in
what
way
it
is
safe
to
use
them.
Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
|
Summary
Comments
|
true
Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
|
|
List.note
|
|
Definition
|
Comments
that
apply
to
the
overall
list.
Comments that apply to the overall list.
|
|
Control
|
0..1
0..*
|
|
Type
|
string
Annotation
|
|
List.entry
|
|
Definition
|
Entries
in
this
list.
Entries in this list.
|
|
Control
|
0..*
|
|
Comments
|
If
there
are
no
entries
in
the
list,
an
emptyReason
SHOULD
be
provided.
If there are no entries in the list, an emptyReason SHOULD be provided.
|
|
Invariants
|
Affect
this
element
Affect this element
lst-1
:
A
list
can
only
have
an
emptyReason
if
it
is
empty
(xpath:
not(exists(f:emptyReason)
and
exists(f:entry)))
: A list can only have an emptyReason if it is empty (
expression
: emptyReason.empty() or entry.empty(), xpath: not(exists(f:emptyReason) and exists(f:entry)))
|
|
List.entry.flag
|
|
Definition
|
The
flag
allows
the
system
constructing
the
list
to
indicate
the
role
and
significance
of
the
item
in
the
list.
The flag allows the system constructing the list to indicate the role and significance of the item in the list.
|
|
Control
|
0..1
|
|
Binding
|
Patient
Medicine
Change
Types:
Codes
that
provide
further
information
about
the
reason
and
meaning
of
the
item
in
the
list
(
Patient Medicine Change Types:
Codes that provide further information about the reason and meaning of the item in the list
(
Example
)
|
|
Type
|
CodeableConcept
|
|
Requirements
|
This
field
is
present
to
support
various
clinical
uses
of
lists,
such
as
a
discharge
summary
medication
list,
where
flags
specify
whether
the
medication
was
added,
modified,
or
deleted
from
the
list.
This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list.
|
|
Comments
|
The
flag
can
only
be
understood
in
the
context
of
the
List.code.
If
the
flag
means
that
the
entry
has
actually
been
deleted
from
the
list,
the
deleted
element
SHALL
be
true.
Deleted
can
only
be
used
if
the
List.mode
is
"changes".
The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is "changes".
|
|
List.entry.deleted
|
|
Definition
|
True
if
this
item
is
marked
as
deleted
in
the
list.
True if this item is marked as deleted in the list.
|
|
Control
|
0..1
|
|
Type
|
boolean
|
Is
Modifier
Is Modifier
|
true
|
Default
Value
Default Value
|
false
|
|
Requirements
|
The
flag
element
may
contain
codes
that
an
application
processing
the
list
does
not
understand.
However
there
can
be
no
ambiguity
if
a
list
item
is
actually
marked
as
"deleted".
The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as "deleted".
|
|
Comments
|
If
the
flag
means
that
the
entry
has
actually
been
deleted
from
the
list,
the
deleted
element
SHALL
be
true.
Both
flag
and
deleted
can
only
be
used
if
the
List.mode
is
"changes".
A
deleted
entry
should
be
displayed
in
narrative
as
deleted.
If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is "changes". A deleted entry should be displayed in narrative as deleted.
|
|
Invariants
|
Affect
this
element
Affect this element
lst-2
:
The
deleted
flag
can
only
be
used
if
the
mode
of
the
list
is
"changes"
(xpath:
(f:mode/@value
=
'changes')
or
not(exists(f:entry/f:deleted)))
: The deleted flag can only be used if the mode of the list is "changes" (
expression
: mode = 'changes' or entry.deleted.empty(), xpath: (f:mode/@value = 'changes') or not(exists(f:entry/f:deleted)))
|
|
List.entry.date
|
|
Definition
|
When
this
item
was
added
to
the
list.
When this item was added to the list.
|
|
Control
|
0..1
|
|
Type
|
dateTime
|
|
Requirements
|
The
date
may
be
significant
for
understanding
the
meaning
of
items
in
a
working
list.
The date may be significant for understanding the meaning of items in a working list.
|
|
Comments
|
This
is
only
useful
and
meaningful
when
the
mode
is
"working".
This is only useful and meaningful when the mode is "working".
|
|
List.entry.item
|
|
Definition
|
A
reference
to
the
actual
resource
from
which
data
was
derived.
A reference to the actual resource from which data was derived.
|
|
Control
|
1..1
|
|
Type
|
Reference
(
Any
)
|
|
List.emptyReason
|
|
Definition
|
If
the
list
is
empty,
why
the
list
is
empty.
If the list is empty, why the list is empty.
|
|
Control
|
0..1
|
|
Binding
|
List
Empty
Reasons:
If
a
list
is
empty,
why
it
is
empty
(
List Empty Reasons:
If a list is empty, why it is empty
(
Preferred
)
|
|
Type
|
CodeableConcept
|
|
Requirements
|
Allows
capturing
things
like
"none
exist"
or
"not
asked"
which
can
be
important
for
most
lists.
Allows capturing things like "none exist" or "not asked" which can be important for most lists.
|
|
Comments
|
The
various
reasons
for
an
empty
list
make
a
significant
interpretation
to
its
interpretation.
Note
that
this
code
is
for
use
when
the
entire
list
has
been
suppressed,
and
not
for
when
individual
items
are
omitted
-
implementers
may
consider
using
a
text
note
or
a
flag
on
an
entry
in
these
cases.
The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.
|
|
Invariants
|
Affect
this
element
Affect this element
lst-1
:
A
list
can
only
have
an
emptyReason
if
it
is
empty
(xpath:
not(exists(f:emptyReason)
and
exists(f:entry)))
: A list can only have an emptyReason if it is empty (
expression
©
HL7.org
2011+.
FHIR
DSTU2
(v1.0.2-7202)
generated
on
Sat,
Oct
24,
2015
07:43+1100.
Links:
Search
: emptyReason.empty() or entry.empty(), xpath: not(exists(f:emptyReason) and exists(f:entry)))
|
|
Version
History
|
Table
of
Contents
|
Compare
to
DSTU1