Detailed
Descriptions
for
the
elements
in
the
DocumentReference
resource.
|
DocumentReference
|
|
Element
Id
|
DocumentReference
|
|
Definition
|
A
reference
to
a
document
of
any
kind
for
any
purpose.
Provides
metadata
about
the
document
so
that
While
the
document
can
be
discovered
and
managed.
The
scope
of
term
“document”
implies
a
document
is
more
narrow
focus,
for
this
resource
this
"document"
encompasses
any
seralized
serialized
object
with
a
mime-type,
so
it
includes
formal
patient
centric
patient-centric
documents
(CDA),
cliical
clinical
notes,
scanned
paper,
and
non-patient
specific
documents
like
policy
text.
text,
as
well
as
a
photo,
video,
or
audio
recording
acquired
or
used
in
healthcare.
The
DocumentReference
resource
provides
metadata
about
the
document
so
that
the
document
can
be
discovered
and
managed.
The
actual
content
may
be
inline
base64
encoded
data
or
provided
by
direct
reference.
|
|
Short
Display
|
A
reference
to
a
document
|
|
Cardinality
|
0..*
|
|
Type
|
DomainResource
|
|
Summary
|
false
|
|
Comments
|
Usually,
this
is
used
for
documents
other
than
those
defined
by
FHIR.
|
|
Invariants
| |
Defined
on
this
element
| |
docRef-1
|
Warning
|
facilityType
SHALL
only
be
present
if
context
is
not
an
encounter
|
facilityType.empty()
or
context.where(resolve()
is
Encounter).empty()
| |
docRef-2
|
Warning
|
practiceSetting
SHALL
only
be
present
if
context
is
not
present
|
practiceSetting.empty()
or
context.where(resolve()
is
Encounter).empty()
|
|
DocumentReference.masterIdentifier
DocumentReference.identifier
|
|
Element
Id
|
DocumentReference.masterIdentifier
DocumentReference.identifier
|
|
Definition
|
Document
identifier
as
assigned
by
the
source
of
Other
business
identifiers
associated
with
the
document.
This
identifier
is
specific
to
this
document,
including
version
of
independent
identifiers.
|
|
Short
Display
|
Business
identifiers
for
the
document.
document
|
|
Note
|
This
unique
is
a
business
identifier,
not
a
resource
identifier
may
be
used
elsewhere
to
identify
this
version
of
the
document.
(see
discussion
)
|
|
Cardinality
|
0..1
0..*
|
|
Type
|
Identifier
|
|
Requirements
|
Document
identifiers
usually
assigned
by
the
source
of
the
document,
or
other
business
identifiers
such
as
XDS
DocumentEntry.uniqueId
and
DocumentEntry.entryUUID.
These
identifiers
are
specific
to
this
instance
of
the
document.
|
|
Summary
|
true
|
|
Comments
|
The
structure
and
format
of
this
Id
shall
identifier
would
be
consistent
with
the
specification
corresponding
to
the
formatCode
attribute.
format
of
the
document.
(e.g.
for
a
DICOM
standard
document
document,
a
64-character
numeric
UID,
UID;
for
an
HL7
CDA
format
a
serialization
of
format,
the
CDA
Document
Id
extension
and
root
in
the
form
"oid^extension",
where
OID
is
a
64
digits
max,
and
the
extension).
|
|
DocumentReference.version
|
Element
Id
is
|
DocumentReference.version
|
|
Definition
|
An
explicitly
assigned
identifer
of
a
16
UTF-8
char
max.
If
variation
of
the
OID
is
coded
without
content
in
the
extension
then
DocumentReference.
|
|
Short
Display
|
An
explicitly
assigned
identifer
of
a
variation
of
the
'^'
character
shall
content
in
the
DocumentReference
|
|
Note
|
This
is
a
business
versionId,
not
be
included.).
a
resource
version
id
(see
discussion
)
|
|
Cardinality
|
0..1
|
|
Type
|
string
|
|
Summary
|
true
|
|
Comments
|
CDA
Document
Id
extension
While
each
resource,
including
the
DocumentReference
itself,
has
its
own
version
identifier,
this
is
a
formal
identifier
for
the
logical
version
of
the
DocumentReference
as
a
whole.
It
would
remain
constant
if
the
resources
were
moved
to
a
new
server,
and
root.
all
got
new
individual
resource
versions,
for
example.
|
DocumentReference.identifier
DocumentReference.basedOn
|
|
Element
Id
|
DocumentReference.identifier
DocumentReference.basedOn
|
|
Definition
|
Other
identifiers
associated
with
A
procedure
that
is
fulfilled
in
whole
or
in
part
by
the
document,
including
version
independent
identifiers.
creation
of
this
media.
|
Note
Short
Display
|
This
is
a
business
identifier,
not
a
resource
identifier
(see
discussion
)
Procedure
that
caused
this
media
to
be
created
|
|
Cardinality
|
0..*
|
|
Type
|
Identifier
Reference
(
Appointment
|
AppointmentResponse
|
CarePlan
|
Claim
|
CommunicationRequest
|
Contract
|
CoverageEligibilityRequest
|
DeviceRequest
|
EnrollmentRequest
|
ImmunizationRecommendation
|
MedicationRequest
|
NutritionOrder
|
RequestOrchestration
|
ServiceRequest
|
SupplyRequest
|
VisionPrescription
)
|
|
Requirements
|
Allows
tracing
of
authorization
for
the
event
and
tracking
whether
proposals/recommendations
were
acted
upon.
|
|
Alternate
Names
|
fulfills
|
|
Summary
|
true
false
|
|
DocumentReference.status
|
|
Element
Id
|
DocumentReference.status
|
|
Definition
|
The
status
of
this
document
reference.
|
|
Short
Display
|
current
|
superseded
|
entered-in-error
|
|
Cardinality
|
1..1
|
|
Terminology
Binding
|
DocumentReferenceStatus
(
Required
)
|
|
Type
|
code
|
|
Is
Modifier
|
true
(Reason:
This
element
is
labelled
as
a
modifier
because
it
is
a
status
element
that
contains
status
entered-in-error
which
means
that
the
resource
should
not
be
treated
as
valid)
|
|
Summary
|
true
|
|
Comments
|
This
is
the
status
of
the
DocumentReference
object,
which
might
be
independent
from
the
docStatus
element.
This
element
is
labeled
as
a
modifier
because
the
status
contains
the
codes
that
mark
the
document
or
reference
as
not
currently
valid.
|
|
DocumentReference.docStatus
|
|
Element
Id
|
DocumentReference.docStatus
|
|
Definition
|
The
status
of
the
underlying
document.
|
|
Short
Display
|
registered
|
partial
|
preliminary
|
final
|
amended
|
corrected
|
appended
|
cancelled
|
entered-in-error
|
deprecated
|
unknown
|
|
Cardinality
|
0..1
|
|
Terminology
Binding
|
CompositionStatus
Composition
Status
(
Required
)
|
|
Type
|
code
|
|
Summary
|
true
|
|
Comments
|
The
document
that
is
pointed
to
might
be
in
various
lifecycle
states.
|
|
DocumentReference.modality
|
|
Element
Id
|
DocumentReference.modality
|
|
Definition
|
Imaging
modality
used.
This
may
include
both
acquisition
and
non-acquisition
modalities.
|
|
Short
Display
|
Imaging
modality
used
|
|
Cardinality
|
0..*
|
|
Terminology
Binding
|
Modality
(
Extensible
)
|
|
Type
|
CodeableConcept
|
|
Summary
|
true
|
|
DocumentReference.type
|
|
Element
Id
|
DocumentReference.type
|
|
Definition
|
Specifies
the
particular
kind
of
document
referenced
(e.g.
History
and
Physical,
Discharge
Summary,
Progress
Note).
This
usually
equates
to
the
purpose
of
making
the
document
referenced.
|
|
Short
Display
|
Kind
of
document
(LOINC
if
possible)
|
|
Cardinality
|
0..1
|
|
Terminology
Binding
|
FHIR
Document
Type
Codes
(
Preferred
)
|
|
Type
|
CodeableConcept
|
|
Summary
|
true
|
|
Comments
|
Key
metadata
element
describing
the
document
that
describes
he
exact
type
of
document.
Helps
humans
to
assess
whether
the
document
is
of
interest
when
viewing
a
list
of
documents.
|
|
DocumentReference.category
|
|
Element
Id
|
DocumentReference.category
|
|
Definition
|
A
categorization
for
the
type
of
document
referenced
-
helps
for
indexing
and
searching.
This
may
be
implied
by
or
derived
from
the
code
specified
in
the
DocumentReference.type.
|
|
Short
Display
|
Categorization
of
document
|
|
Cardinality
|
0..*
|
|
Terminology
Binding
|
Document
Class
Referenced
Item
Category
Value
Set
(
Example
)
|
|
Type
|
CodeableConcept
|
|
Alternate
Names
|
claxs
class;
classCode
|
|
Summary
|
true
|
|
Comments
|
Key
metadata
element
describing
the
the
category
or
classification
of
the
document.
This
is
a
broader
perspective
that
groups
similar
documents
based
on
how
they
would
be
used.
This
is
a
primary
key
used
in
searching.
|
|
DocumentReference.subject
|
|
Element
Id
|
DocumentReference.subject
|
|
Definition
|
Who
or
what
the
document
is
about.
The
document
can
be
about
a
person,
(patient
or
healthcare
practitioner),
a
device
(e.g.
a
machine)
or
even
a
group
of
subjects
(such
as
a
document
about
a
herd
of
farm
animals,
or
a
set
of
patients
that
share
a
common
exposure).
|
|
Short
Display
|
Who/what
is
the
subject
of
the
document
|
|
Cardinality
|
0..1
|
|
Type
|
Reference
(
Patient
|
Practitioner
|
Group
|
Device
Any
)
|
|
Summary
|
true
|
DocumentReference.date
DocumentReference.context
|
|
Element
Id
|
DocumentReference.date
DocumentReference.context
|
|
Definition
|
When
Describes
the
clinical
encounter
or
type
of
care
that
the
document
reference
was
created.
content
is
associated
with.
|
|
Short
Display
|
Context
of
the
document
content
|
|
Cardinality
|
0..1
0..*
|
|
Type
|
instant
Reference
(
Appointment
|
Encounter
|
EpisodeOfCare
)
|
|
Summary
|
false
|
Alternate
Names
Invariants
|
indexed
|
Affect
this
element
|
|
docRef-1
|
Summary
Warning
|
facilityType
SHALL
only
be
present
if
context
is
not
an
encounter
|
true
facilityType.empty()
or
context.where(resolve()
is
Encounter).empty()
|
|
docRef-2
|
Comments
Warning
|
practiceSetting
SHALL
only
be
present
if
context
is
not
present
|
Referencing/indexing
time
practiceSetting.empty()
or
context.where(resolve()
is
used
for
tracking,
organizing
versions
and
searching.
Encounter).empty()
|
|
DocumentReference.author
DocumentReference.event
|
|
Element
Id
|
DocumentReference.author
DocumentReference.event
|
|
Definition
|
Identifies
who
This
list
of
codes
represents
the
main
clinical
acts,
such
as
a
colonoscopy
or
an
appendectomy,
being
documented.
In
some
cases,
the
event
is
responsible
for
adding
inherent
in
the
information
to
type
Code,
such
as
a
"History
and
Physical
Report"
in
which
the
document.
procedure
being
documented
is
necessarily
a
"History
and
Physical"
act.
|
|
Short
Display
|
Main
clinical
acts
documented
|
|
Cardinality
|
0..*
|
Type
Terminology
Binding
|
Reference
v3
Code
System
ActCode
(
Practitioner
|
PractitionerRole
|
Organization
|
Device
Example
|
Patient
)
|
Type
|
RelatedPerson
|
CodeableReference
)
|
|
Summary
|
true
false
|
|
Comments
|
Not
necessarily
who
did
An
event
can
further
specialize
the
actual
data
entry
(i.e.
typist)
or
who
act
inherent
in
the
type,
such
as
where
it
is
simply
"Procedure
Report"
and
the
procedure
was
a
"colonoscopy".
If
one
or
more
event
codes
are
included,
they
shall
not
conflict
with
the
source
(informant).
values
inherent
in
the
class
or
type
elements
as
such
a
conflict
would
create
an
ambiguous
situation.
|
DocumentReference.authenticator
DocumentReference.bodySite
|
|
Element
Id
|
DocumentReference.authenticator
DocumentReference.bodySite
|
|
Definition
|
Which
person
or
organization
authenticates
that
this
document
is
valid.
The
anatomic
structures
included
in
the
document.
|
|
Short
Display
|
Body
part
included
|
|
Cardinality
|
0..1
0..*
|
Type
Terminology
Binding
|
Reference
SNOMED
CT
Body
Structures
(
Practitioner
|
PractitionerRole
|
Organization
Example
)
|
Summary
Type
|
false
CodeableReference
(
BodyStructure
)
|
Comments
Summary
|
Represents
a
participant
within
the
author
institution
who
has
legally
authenticated
or
attested
the
document.
Legal
authentication
implies
that
a
document
has
been
signed
manually
or
electronically
by
the
legal
Authenticator.
true
|
DocumentReference.custodian
DocumentReference.facilityType
|
|
Element
Id
|
DocumentReference.custodian
DocumentReference.facilityType
|
|
Definition
|
Identifies
the
organization
or
group
who
is
responsible
for
ongoing
maintenance
The
kind
of
and
access
to
facility
where
the
document.
patient
was
seen.
|
|
Short
Display
|
Kind
of
facility
where
patient
was
seen
|
|
Cardinality
|
0..1
|
Type
Terminology
Binding
|
Reference
Facility
Type
Code
Value
Set
(
Organization
Example
)
|
Summary
Type
|
false
CodeableConcept
Comments
Identifies
the
logical
organization
(software
system,
vendor,
or
department)
to
go
to
find
the
current
version,
where
to
report
issues,
etc.
This
is
different
from
the
physical
location
(URL,
disk
drive,
or
server)
of
the
document,
which
is
the
technical
location
of
the
document,
which
host
may
be
delegated
to
the
management
of
some
other
organization.
|
Summary
DocumentReference.relatesTo
|
false
|
Element
Id
Invariants
|
DocumentReference.relatesTo
Definition
Relationships
that
Affect
this
document
has
with
other
document
references
that
already
exist.
element
|
Cardinality
docRef-1
|
0..*
Summary
Warning
|
true
facilityType
SHALL
only
be
present
if
context
is
not
an
encounter
|
Comments
facilityType.empty()
or
context.where(resolve()
is
Encounter).empty()
|
This
element
is
labeled
as
a
modifier
because
documents
that
append
to
other
documents
are
incomplete
on
their
own.
|
DocumentReference.relatesTo.code
DocumentReference.practiceSetting
|
|
Element
Id
|
DocumentReference.relatesTo.code
DocumentReference.practiceSetting
|
|
Definition
|
The
type
of
relationship
that
this
document
has
with
anther
document.
This
property
may
convey
specifics
about
the
practice
setting
where
the
content
was
created,
often
reflecting
the
clinical
specialty.
|
|
Short
Display
|
Additional
details
about
where
the
content
was
created
(e.g.
clinical
specialty)
|
|
Cardinality
|
1..1
0..1
|
|
Terminology
Binding
|
DocumentRelationshipType
Practice
Setting
Code
Value
Set
(
Required
Example
)
|
|
Type
|
code
CodeableConcept
|
|
Requirements
|
This
is
an
important
piece
of
metadata
that
providers
often
rely
upon
to
quickly
sort
and/or
filter
out
to
find
specific
content.
|
|
Summary
|
true
false
|
|
Comments
|
If
this
document
appends
another
document,
then
the
document
cannot
This
element
should
be
fully
understood
without
also
accessing
based
on
a
coarse
classification
system
for
the
referenced
document.
class
of
specialty
practice.
Recommend
the
use
of
the
classification
system
for
Practice
Setting,
such
as
that
described
by
the
Subject
Matter
Domain
in
LOINC.
|
|
Invariants
| |
Affect
this
element
| |
docRef-2
|
Warning
|
practiceSetting
SHALL
only
be
present
if
context
is
not
present
|
practiceSetting.empty()
or
context.where(resolve()
is
Encounter).empty()
|
|
DocumentReference.relatesTo.target
DocumentReference.period
|
|
Element
Id
|
DocumentReference.relatesTo.target
DocumentReference.period
|
|
Definition
|
The
target
time
period
over
which
the
service
that
is
described
by
the
document
of
this
relationship.
was
provided.
|
|
Short
Display
|
Time
of
service
that
is
being
documented
|
|
Cardinality
|
1..1
0..1
|
|
Type
|
Reference
(
DocumentReference
Period
)
|
|
Summary
|
true
|
DocumentReference.description
DocumentReference.date
|
|
Element
Id
|
DocumentReference.description
DocumentReference.date
|
|
Definition
|
Human-readable
description
of
When
the
source
document.
document
reference
was
created.
|
|
Short
Display
|
When
this
document
reference
was
created
|
|
Cardinality
|
0..1
|
|
Type
|
string
instant
|
Requirements
Alternate
Names
|
Helps
humans
to
assess
whether
the
document
is
of
interest.
indexed
|
|
Summary
|
true
|
|
Comments
|
What
the
document
Referencing/indexing
time
is
about,
a
terse
summary
of
the
document.
used
for
tracking,
organizing
versions
and
searching.
|
DocumentReference.securityLabel
DocumentReference.author
|
|
Element
Id
|
DocumentReference.securityLabel
DocumentReference.author
|
|
Definition
|
A
set
of
Security-Tag
codes
specifying
the
level
of
privacy/security
of
the
Document.
Note
that
DocumentReference.meta.security
contains
the
security
labels
of
Identifies
who
is
responsible
for
adding
the
"reference"
information
to
the
document,
while
DocumentReference.securityLabel
contains
a
snapshot
of
the
security
labels
on
document.
|
|
Short
Display
|
Who
and/or
what
authored
the
document
the
reference
refers
to.
|
|
Cardinality
|
0..*
|
Terminology
Binding
Type
|
SecurityLabels
Reference
(
Extensible
Practitioner
|
PractitionerRole
|
Organization
|
Device
|
Patient
|
RelatedPerson
|
CareTeam
)
|
Type
Summary
|
true
|
CodeableConcept
|
Comments
|
Not
necessarily
who
did
the
actual
data
entry
(i.e.
typist)
or
who
was
the
source
(informant).
|
|
DocumentReference.attester
|
Requirements
Element
Id
|
DocumentReference.attester
|
|
Definition
|
Use
of
A
participant
who
has
authenticated
the
Health
Care
Privacy/Security
Classification
(HCS)
system
accuracy
of
security-tag
use
is
recommended.
the
document.
|
|
Short
Display
|
Summary
Attests
to
accuracy
of
the
document
|
|
Cardinality
|
true
0..*
|
Comments
Requirements
|
The
confidentiality
codes
can
carry
multiple
vocabulary
items.
HL7
has
developed
an
understanding
of
security
and
privacy
tags
that
might
be
desirable
in
a
Document
Sharing
environment,
called
HL7
Healthcare
Privacy
and
Security
Classification
System
(HCS).
The
following
specification
is
recommended
but
not
mandated,
as
Identifies
responsibility
for
the
vocabulary
bindings
are
an
administrative
domain
responsibility.
The
use
accuracy
of
this
method
is
up
to
the
policy
domain
such
as
the
XDS
Affinity
Domain
or
other
Trust
Domain
where
all
parties
including
sender
and
recipients
are
trusted
to
appropriately
tag
and
enforce.
document
content.
|
|
Summary
|
false
|
|
Comments
|
In
the
HL7
Healthcare
Privacy
and
Security
Classification
(HCS)
there
are
code
systems
specific
to
Confidentiality,
Sensitivity,
Integrity,
and
Handling
Caveats.
Some
values
would
come
from
a
local
vocabulary
as
they
are
related
to
workflow
roles
and
special
projects.
Only
list
each
attester
once.
|
DocumentReference.content
DocumentReference.attester.mode
|
|
Element
Id
|
DocumentReference.content
DocumentReference.attester.mode
|
|
Definition
|
The
document
and
format
referenced.
There
may
be
multiple
content
element
repetitions,
each
with
a
different
format.
type
of
attestation
the
authenticator
offers.
|
|
Short
Display
|
personal
|
professional
|
legal
|
official
|
|
Cardinality
|
1..*
1..1
|
|
Terminology
Binding
|
Composition
Attestation
Mode
(
Preferred
)
|
|
Type
|
CodeableConcept
|
|
Requirements
|
Indicates
the
level
of
authority
of
the
attestation.
|
|
Summary
|
true
false
|
DocumentReference.content.attachment
DocumentReference.attester.time
|
|
Element
Id
|
DocumentReference.content.attachment
DocumentReference.attester.time
|
|
Definition
|
The
document
or
URL
of
When
the
document
along
with
critical
metadata
to
prove
content
has
integrity.
was
attested
by
the
party.
|
|
Short
Display
|
When
the
document
was
attested
|
|
Cardinality
|
1..1
0..1
|
|
Type
|
Attachment
dateTime
|
|
Requirements
|
Identifies
when
the
information
in
the
document
was
deemed
accurate.
(Things
may
have
changed
since
then.).
|
|
Summary
|
true
false
|
DocumentReference.content.format
DocumentReference.attester.party
|
|
Element
Id
|
DocumentReference.content.format
DocumentReference.attester.party
|
|
Definition
|
An
identifier
of
the
document
encoding,
structure,
and
template
that
Who
attested
the
document
conforms
to
beyond
the
base
format
indicated
in
the
mimeType.
specified
way.
|
|
Short
Display
|
Who
attested
the
document
|
|
Cardinality
|
0..1
|
Terminology
Binding
Type
|
DocumentReference
Format
Code
Set
Reference
(
Preferred
Patient
|
RelatedPerson
|
Practitioner
|
PractitionerRole
|
Organization
)
|
Type
Requirements
|
Coding
Identifies
who
has
taken
on
the
responsibility
for
accuracy
of
the
document
content.
|
|
Summary
|
true
Comments
Note
that
while
IHE
mostly
issues
URNs
for
format
types,
not
all
documents
can
be
identified
by
a
URI.
false
|
DocumentReference.context
DocumentReference.custodian
|
|
Element
Id
|
DocumentReference.context
DocumentReference.custodian
|
|
Definition
|
The
clinical
context
in
Identifies
the
organization
or
group
who
is
responsible
for
ongoing
maintenance
of
and
access
to
the
document.
|
|
Short
Display
|
Organization
which
maintains
the
document
was
prepared.
|
|
Cardinality
|
0..1
|
|
Type
|
Reference
(
Organization
)
|
|
Summary
|
true
false
|
|
Comments
|
These
values
are
primarily
added
Identifies
the
logical
organization
(software
system,
vendor,
or
department)
to
help
with
searching
for
interesting/relevant
documents.
go
to
find
the
current
version,
where
to
report
issues,
etc.
This
is
different
from
the
physical
location
(URL,
disk
drive,
or
server)
of
the
document,
which
is
the
technical
location
of
the
document,
which
host
may
be
delegated
to
the
management
of
some
other
organization.
|
DocumentReference.context.encounter
DocumentReference.relatesTo
|
|
Element
Id
|
DocumentReference.context.encounter
DocumentReference.relatesTo
|
|
Definition
|
Describes
the
clinical
encounter
or
type
of
care
Relationships
that
the
this
document
content
is
associated
with.
has
with
other
document
references
that
already
exist.
|
|
Short
Display
|
Relationships
to
other
documents
|
|
Cardinality
|
0..*
|
Type
Summary
|
Reference
(
Encounter
|
EpisodeOfCare
)
true
|
Summary
Comments
|
false
This
element
is
labeled
as
a
modifier
because
documents
that
append
to
other
documents
are
incomplete
on
their
own.
|
DocumentReference.context.event
DocumentReference.relatesTo.code
|
|
Element
Id
|
DocumentReference.context.event
DocumentReference.relatesTo.code
|
|
Definition
|
This
list
of
codes
represents
the
main
clinical
acts,
such
as
a
colonoscopy
or
an
appendectomy,
being
documented.
In
some
cases,
the
event
is
inherent
in
the
The
type
Code,
such
as
a
"History
and
Physical
Report"
in
which
the
procedure
being
documented
is
necessarily
a
"History
and
Physical"
act.
of
relationship
that
this
document
has
with
anther
document.
|
|
Short
Display
|
The
relationship
type
with
another
document
|
|
Cardinality
|
0..*
1..1
|
|
Terminology
Binding
|
v3
Code
System
ActCode
Document
Relationship
Type
(
Example
Extensible
)
|
|
Type
|
CodeableConcept
|
|
Summary
|
false
true
|
|
Comments
|
An
event
can
further
specialize
the
act
inherent
in
the
type,
such
as
where
it
is
simply
"Procedure
Report"
and
the
procedure
was
a
"colonoscopy".
If
one
or
more
event
codes
are
included,
they
shall
not
conflict
with
this
document
appends
another
document,
then
the
values
inherent
in
document
cannot
be
fully
understood
without
also
accessing
the
class
or
type
elements
as
such
a
conflict
would
create
an
ambiguous
situation.
referenced
document.
|
DocumentReference.context.period
DocumentReference.relatesTo.target
|
|
Element
Id
|
DocumentReference.context.period
DocumentReference.relatesTo.target
|
|
Definition
|
The
time
period
over
which
the
service
that
is
described
by
the
target
document
was
provided.
of
this
relationship.
|
|
Short
Display
|
Target
of
the
relationship
|
|
Cardinality
|
0..1
1..1
|
|
Type
|
Period
Reference
(
DocumentReference
)
|
|
Summary
|
true
|
DocumentReference.context.facilityType
DocumentReference.description
|
|
Element
Id
|
DocumentReference.context.facilityType
DocumentReference.description
|
|
Definition
|
The
kind
Human-readable
description
of
facility
where
the
patient
was
seen.
source
document.
|
|
Short
Display
|
Human-readable
description
|
|
Cardinality
|
0..1
|
Terminology
Binding
Type
|
Facility
Type
Code
Value
Set
(
Example
markdown
)
|
Type
Requirements
|
CodeableConcept
Helps
humans
to
assess
whether
the
document
is
of
interest.
|
|
Summary
|
false
true
|
|
Comments
|
What
the
document
is
about,
a
terse
summary
of
the
document.
|
DocumentReference.context.practiceSetting
DocumentReference.securityLabel
|
|
Element
Id
|
DocumentReference.context.practiceSetting
DocumentReference.securityLabel
|
|
Definition
|
This
property
A
set
of
Security-Tag
codes
specifying
the
level
of
privacy/security
of
the
Document
found
at
DocumentReference.content.attachment.url.
Note
that
DocumentReference.meta.security
contains
the
security
labels
of
the
data
elements
in
DocumentReference,
while
DocumentReference.securityLabel
contains
the
security
labels
for
the
document
the
reference
refers
to.
The
distinction
recognizes
that
the
document
may
convey
specifics
contain
sensitive
information,
while
the
DocumentReference
is
metadata
about
the
practice
setting
where
document
and
thus
might
not
be
as
sensitive
as
the
content
was
created,
often
reflecting
document.
For
example:
a
psychotherapy
episode
may
contain
highly
sensitive
information,
while
the
clinical
specialty.
metadata
may
simply
indicate
that
some
episode
happened.
|
|
Short
Display
|
Document
security-tags
|
|
Cardinality
|
0..1
0..*
|
|
Terminology
Binding
|
Practice
Setting
Code
Value
Set
Example
set
of
Security
Labels
(
Example
)
|
|
Type
|
CodeableConcept
|
|
Requirements
|
This
is
an
important
piece
Use
of
metadata
that
providers
often
rely
upon
to
quickly
sort
and/or
filter
out
to
find
specific
content.
the
Health
Care
Privacy/Security
Classification
(HCS)
system
of
security-tag
use
is
recommended.
|
|
Summary
|
false
true
|
|
Comments
|
This
element
should
The
confidentiality
codes
can
carry
multiple
vocabulary
items.
HL7
has
developed
an
understanding
of
security
and
privacy
tags
that
might
be
based
on
desirable
in
a
coarse
classification
system
for
the
class
of
specialty
practice.
Recommend
Document
Sharing
environment,
called
HL7
Healthcare
Privacy
and
Security
Classification
System
(HCS).
The
following
specification
is
recommended
but
not
mandated,
as
the
vocabulary
bindings
are
an
administrative
domain
responsibility.
The
use
of
this
method
is
up
to
the
classification
system
for
Practice
Setting,
policy
domain
such
as
that
described
by
the
Subject
Matter
XDS
Affinity
Domain
in
LOINC.
or
other
Trust
Domain
where
all
parties
including
sender
and
recipients
are
trusted
to
appropriately
tag
and
enforce.
In
the
HL7
Healthcare
Privacy
and
Security
Classification
(HCS)
there
are
code
systems
specific
to
Confidentiality,
Sensitivity,
Integrity,
and
Handling
Caveats.
Some
values
would
come
from
a
local
vocabulary
as
they
are
related
to
workflow
roles
and
special
projects.
|
DocumentReference.context.sourcePatientInfo
DocumentReference.content
|
|
Element
Id
|
DocumentReference.context.sourcePatientInfo
DocumentReference.content
|
|
Definition
|
The
Patient
Information
as
known
when
document
and
format
referenced.
If
there
are
multiple
content
element
repetitions,
these
must
all
represent
the
same
document
was
published.
May
be
a
reference
to
a
version
specific,
in
different
format,
or
contained.
attachment
metadata.
|
|
Short
Display
|
Document
referenced
|
|
Cardinality
|
0..1
1..*
|
Type
Requirements
|
Reference
(
Patient
)
Note
that
.relatesTo
may
also
include
references
to
other
DocumentReference
with
a
transforms
relationship
to
represent
the
same
document
in
multiple
formats.
|
|
Summary
|
false
true
|
|
Comments
|
content
element
shall
not
contain
different
versions
of
the
same
content.
For
version
handling
use
multiple
DocumentReference
with
.relatesTo.
|
DocumentReference.context.related
DocumentReference.content.attachment
|
|
Element
Id
|
DocumentReference.context.related
DocumentReference.content.attachment
|
|
Definition
|
Related
identifiers
The
document
or
resources
associated
with
URL
of
the
DocumentReference.
document
along
with
critical
metadata
to
prove
content
has
integrity.
|
|
Short
Display
|
Where
to
access
the
document
|
|
Cardinality
|
0..*
1..1
|
|
Type
|
Reference
Attachment
(
Any
|
Summary
)
|
true
|
|
DocumentReference.content.profile
|
|
Element
Id
|
DocumentReference.content.profile
|
|
Definition
|
An
identifier
of
the
document
constraints,
encoding,
structure,
and
template
that
the
document
conforms
to
beyond
the
base
format
indicated
in
the
mimeType.
|
|
Short
Display
|
Content
profile
rules
for
the
document
|
|
Cardinality
|
0..*
|
|
Alternate
Names
|
format;
formatCode
|
|
Summary
|
false
true
|
|
Comments
|
May
Note
that
IHE
often
issues
URNs
for
formatCode
codes,
not
all
documents
can
be
identifiers
or
resources
identified
by
a
URI.
For
FHIR
content,
.profile
should
indicate
the
structureDefinition
profile
canonical
URI(s)
that
caused
the
DocumentReference
or
referenced
content
complies
with.
|
|
DocumentReference.content.profile.value[x]
|
|
Element
Id
|
DocumentReference.content.profile.value[x]
|
|
Definition
|
Code|uri|canonical.
|
|
Short
Display
|
Code|uri|canonical
|
|
Cardinality
|
1..1
|
|
Terminology
Binding
|
HL7
ValueSet
of
Format
Codes
for
use
with
Document
Sharing
(
Preferred
)
|
|
Type
|
Coding
|
uri
|
canonical
|
|
[x]
Note
|
See
Choice
of
Datatypes
for
further
information
about
how
to
be
created.
use
[x]
|
|
Summary
|
true
|