This page is part of the FHIR Specification (v1.4.0:
STU
3 Ballot 3). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
This is the narrative for the resource. See also the
XML
or
or
JSON
format.
format.
OPERATION:
Generate
a
Document
OPERATION: Generate a Document
A
client
can
ask
a
server
to
generate
a
fully
bundled
document
from
a
composition
resource.
The
server
takes
the
composition
resource,
locates
all
the
referenced
resources
and
other
additional
resources
as
configured
or
requested
and
either
returns
a
full
document
bundle,
or
returns
an
error.
Note
that
since
this
is
a
search
operation,
the
document
bundle
is
wrapped
inside
the
search
bundle.
If
some
of
the
resources
are
located
on
other
servers,
it
is
at
the
discretion
of
the
server
whether
to
retrieve
them
or
return
an
error.
If
the
correct
version
of
the
document
that
would
be
generated
already
exists,
then
the
server
can
return
the
existing
one.
A client can ask a server to generate a fully bundled document from a composition resource. The server takes the composition resource, locates all the referenced resources and other additional resources as configured or requested and either returns a full document bundle, or returns an error. Note that since this is a search operation, the document bundle is wrapped inside the search bundle. If some of the resources are located on other servers, it is at the discretion of the server whether to retrieve them or return an error. If the correct version of the document that would be generated already exists, then the server can return the existing one.
URL: [base]/Composition/$document
URL:
[base]/Composition/$document
URL: [base]/Composition/[id]/$document
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | persist | 0..1 | boolean |
|
Note:
this
operation
definition
does
not
resolve
the
question
how
document
signatures
are
created.
This
is
an
open
issue
during
the
period
of
trial
use,
and
feedback
is
requested
regarding
this
question
Note: this operation definition does not resolve the question how document signatures are created. This is an open issue during the period of trial use, and feedback is requested regarding this question
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.