DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

6.9.14 Resource Composition - Operations

This resource has 1 operation associated with it. For more information about operations, including how they are invoked, see Operations.

6.9.14.1 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.

Formal Definition (as a OperationDefinition).

URL: [base]/Composition/$document

In Parameters:
NameCardinalityTypeStructureDefinitionDocumentation
persist0..1boolean

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)

cert0..1string

Certificate URL to use to sign the document with. The certificate should be associated with one of the attestors

pword0..1string

Password for private key if certificate requires one and the server doesn't know it by some other means. Putting the password in the URL has obvious security implications to consider. An alternative is for the client to sign the document