Operation-composition-document.xml

Operation Definition

Raw XML

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Composition-document"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/Composition-document"/>
  <name value="Generate a Document"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <description value="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."/>
  <status value="draft"/>
  <date value="2015-02-23T09:07:27+11:00"/>
  <kind value="operation"/>
  <code value="document"/>
  <system value="false"/>
  <type value="Composition"/>
  <instance value="false"/>
  <parameter>
    <name value="persist"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="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)"/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="cert"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Certificate URL to use to sign the document with. The certificate should be associated
     with one of the attestors"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="pword"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="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"/>
    <type value="string"/>
  </parameter>
</OperationDefinition>