Operation-composition-document.xml

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Composition-document"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> Generate a Document</h2> 
      <p> OPERATION: Generate a Document</p> 
      <p> The official URL for this operation definition is: </p> 
      <pre> http://hl7.org/fhir/OperationDefinition/Composition-document</pre> 
      <div> 
        <p> 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.</p> 

      </div> 
      <p> URL: [base]/Composition/$document</p> 
      <p> URL: [base]/Composition/[id]/$document</p> 
      <p> Parameters</p> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Use</b> 
          </td> 
          <td> 
            <b> Name</b> 
          </td> 
          <td> 
            <b> Cardinality</b> 
          </td> 
          <td> 
            <b> Type</b> 
          </td> 
          <td> 
            <b> Binding</b> 
          </td> 
          <td> 
            <b> Documentation</b> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> persist</td> 
          <td> 0..1</td> 
          <td> boolean</td> 
          <td/>  
          <td> 
            <div> 
              <p> Whether to store the document at the bundle end-point (/Bundle) or not once it is generated.
                 Value = true or false (default is for the server to decide). If the document is stored,
                 it's location can be inferred from the Bundle.id, but it SHOULD be provided explicitly
                 in the HTTP Location header in the response</p> 

            </div> 
          </td> 
        </tr> 
      </table> 
      <div> 
        <p> 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</p> 

      </div> 
    </div> 
  </text> 
  <url value="http://hl7.org/fhir/OperationDefinition/Composition-document"/> 
  <name value="Generate a Document"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2019-10-24T11:53:00+11:00"/> 
  <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."/> 
  <code value="document"/> 
  <comment value="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"/> 
  <resource value="Composition"/> 
  <system value="false"/> 
  <type value="true"/> 
  <instance value="true"/> 
  <parameter> 
    <name value="persist"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="Whether to store the document at the bundle end-point (/Bundle) or not once it is generated.
     Value = true or false (default is for the server to decide). If the document is stored,
     it's location can be inferred from the Bundle.id, but it SHOULD be provided explicitly
     in the HTTP Location header in the response"/> 
    <type value="boolean"/> 
  </parameter> 
</OperationDefinition>