This
page
is
sometimes
known
as
the
"title"
description
:
string
0..1
A
code
specifying
the
level
of
confidentiality
of
the
XDS
Document
(this
element
modifies
the
meaning
of
other
elements)
confidentiality
:
CodeableConcept
0..*
<<
Codes
specifying
the
level
of
confidentiality
of
the
composition
DocumentConfidentiality
>>
The
primary
language
in
which
the
source
document
is
written
primaryLanguage
:
code
0..1
<<
A
human
language
Language
>>
The
mime
type
of
the
source
document
mimeType
:
code
1..1
<<
The
mime
type
of
an
attachment
MimeType
>>
An
identifier
that
identifies
that
the
format
and
content
part
of
the
document
conforms
to
additional
rules
beyond
the
base
format
indicated
in
the
mimeType
format
:
uri
FHIR
Specification
(v5.0.0-draft-final:
Final
QA
Preview
for
R5
-
see
ballot
notes
0..*
).
The
size
of
the
source
document
this
reference
refers
to
in
bytes
size
:
integer
0..1
A
hash
of
the
source
document
to
ensure
that
changes
have
not
occurred
hash
:
string
0..1
A
url
at
current
version
which
the
document
can
be
accessed
location
:
uri
0..1
RelatesTo
The
type
of
relationship
that
this
document
has
with
anther
document
code
:
code
1..1
<<
The
type
of
relationship
between
documents
DocumentRelationshipType
>>
The
target
document
of
supercedes
this
relationship
target
:
Resource
(
DocumentReference
)
1..1
Service
The
type
of
the
service
that
can
be
used
to
access
the
documents
type
:
CodeableConcept
1..1
<<
Document
Reference
Service
Type
DocumentServiceType
>>
Where
the
service
end-point
version
is
located
address
:
string
0..1
Parameter
The
name
of
5.0.0
.
For
a
parameter
name
:
string
1..1
The
value
of
the
named
parameter
value
:
string
0..1
Context
This
full
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
typeCode,
such
as
a
"History
and
Physical
Report"
in
which
available
versions,
see
the
procedure
being
documented
is
necessarily
a
"History
and
Physical"
act
event
:
CodeableConcept
0..*
<<
This
list
Directory
of
codes
represents
the
main
clinical
acts
being
documented
DocumentEventType
>>
The
time
period
over
which
the
service
that
is
described
by
the
document
was
provided
period
:
Period
0..1
published
versions
The
kind
of
facility
where
the
patient
was
seen
facilityType
.
Page
versions:
R5
:
CodeableConcept
R4B
0..1
<<
XDS
Facility
Type
DocumentFacilityType
R4
>>
6.4.3.2
Constraints
Inv-1
:
A
location
or
a
service
(or
both)
SHALL
be
provided
(xpath:
exists(f:location)
or
exists(f:service)
)
6.4.4
Implementation
Notes
The
use
of
the
.docStatus
codes
is
discussed
in
the
Composition
description
The
resources
maintain
one
way
relationships
that
point
backwards
-
e.g.
the
document
that
replaces
one
document
points
towards
the
document
that
it
replaced.
The
reverse
relationships
can
be
followed
by
using
indexes
built
from
the
resources.
Typically,
this
is
done
using
the
search
parameters
described
below.
Given
that
documents
may
have
other
documents
that
replace
or
append
them,
clients
should
always
check
these
relationships
when
accessing
documents
6.4.4.1
Document
Formats
In
addition
to
a
mime
type
(which
is
mandatory),
there
is
also
a
format
element
which
carries
a
URI.
This
element
has
one
or
more
identifiers
that
indicate
that
the
format
and/or
content
of
the
document
conforms
to
additional
rules
beyond
the
base
format
indicated
in
the
mimeType.
This
is
most
often
used
when
the
mime-type
is
text/xml,
to
provide
additional
information
for
finding
the
correct
document.
Defined
URIs:
ASTM
CCR
:
urn:astm-org:CCR
CCDA:
urn:hl7-org:sdwg:ccda-level-1:1.1,
urn:hl7-org:sdwg:ccda-level-2:1.1
and
urn:hl7-org:sdwg:ccda-level-3:1.1
IHE
defines
URIs
here
and
OIDs
here
(prefix
OIDs
with
urn:oid:
in
the
resource).
Other
URIs
can
be
used
for
items
not
on
this
list.
6.4.4.2
Generating
a
Document
Reference
A
client
can
ask
a
server
to
generate
a
document
reference
from
a
document.
The
server
reads
the
existing
document
and
generates
a
matching
DocumentReference
resource,
or
returns
one
it
has
previously
generated.
Servers
may
be
able
to
return
or
generate
document
references
for
the
following
types
of
content:
Type
Comments
FHIR
Documents
The
uri
refers
to
an
existing
Document
CDA
Document
The
uri
is
a
reference
to
a
Binary
end-point
that
returns
either
a
CDA
document,
or
some
kind
of
CDA
Package
that
the
server
knows
how
to
process
(e.g.
an
IHE
.zip)
Other
The
server
can
be
asked
to
generate
a
document
reference
page
provides
mappings
for
other
kinds
of
documents.
For
some
of
these
documents
(e.g.
PDF
documents)
a
server
could
only
provide
a
DocumentReference
it
is
already
existed,
or
the
server
had
special
knowledge
of
the
document
The
server
either
returns
a
search
result
containing
a
single
DocumentReference,
or
it
returns
an
error.
If
some
the
URI
refers
to
another
server,
it
is
at
the
discretion
of
the
server
whether
to
retrieve
it
or
return
an
error.
The
operation
is
initiated
by
a
named
query,
using
_query=generate
on
the
/DocumentReference
end
point:
GET [service-url]/DocumentReference/?_query=generate&uri=:url&...
The
"uri"
parameter
is
a
relative
or
absolute
reference
ProductShelfLife
(see
Mappings
to
one
of
the
document
types
described
above.
Other
parameters
may
be
supplied:
Name
Meaning
persist
Whether
to
store
the
document
at
the
document
end-point
(/Document)
or
not
once
it
is
generated.
Value
=
true
or
false
(default
is
for
the
server
to
decide)
6.4.5
Search
Parameters
Search
parameters
for
this
resource.
The
standard
parameters
also
apply.
See
Searching
Standards
for
more
further
information
about
searching
in
REST,
messaging,
and
services.
&
status).