Operation Definition

<?xml version="1.0" encoding="UTF-8"?>

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Composition-document"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p class="res-header-id">
        <b> Generated Narrative: OperationDefinition Composition-document</b> 
      </p> 
      <a name="Composition-document"> </a> 
      <a name="hcComposition-document"> </a> 
      <a name="Composition-document-en-US"> </a> 
      <p> URL: [base]/Composition/[id]/$document</p> 
      <h3> Parameters</h3> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Use</b> 
          </td> 
          <td> 
            <b> Name</b> 
          </td> 
          <td> 
            <b> Scope</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/>  
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#boolean">boolean</a> 
          </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, its 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> 
        <tr> 
          <td> IN</td> 
          <td> graph</td> 
          <td/>  
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#uri">uri</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical
                 reference to a 
                <a href="graphdefinition.html">GraphDefinition</a>  that it controls what resources are to be added to the bundle when building the
                 document. The GraphDefinition can also specify profiles that apply to the various
                 resources
              </p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> return</td> 
          <td/>  
          <td> 1..1</td> 
          <td> 
            <a href="bundle.html">Bundle</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> The bundle containing the composition and resources associated with it. See 
                <a href="documents.html">FHIR Documents</a>  for information on resources that may be included in the bundle.
              </p> 

            </div> 
          </td> 
        </tr> 
      </table> 
      <div> 
        <p> Notes:</p> 

        <ul> 

          <li> The server implementing the operation SHOULD determine a 'high-level water-mark'
             for the document security tags (
            <a href="resource.html#Meta">Bundle.meta.security</a> )) as a whole, based on an analysis of the resources contained within the document
          </li> 

          <li> 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</li> 

        </ul> 

      </div> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="2"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="sd"/> 
  </extension> 
  <url value="http://hl7.org/fhir/OperationDefinition/Composition-document"/> 
  <version value="6.0.0-ballot2"/> 
  <name value="Document"/> 
  <title value="Generate a Document"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <experimental value="false"/> 
  <date value="2024-11-23T22:02:06+00:00"/> 
  <publisher value="HL7 International / Structured Documents"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://www.hl7.org/Special/committees/structure"/> 
    </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. 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."/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <affectsState value="false"/> 
  <code value="document"/> 
  <comment value="Notes:

* The server implementing the operation SHOULD determine a 'high-level water-mark'
   for the document security tags ([Bundle.meta.security](resource.html#Meta))) as
   a whole, based on an analysis of the resources contained within the document
* 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="false"/> 
  <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, its 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> 
  <parameter> 
    <name value="graph"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical
     reference to a [GraphDefinition](graphdefinition.html) that it controls what resources
     are to be added to the bundle when building the document. The GraphDefinition can
     also specify profiles that apply to the various resources"/> 
    <type value="uri"/> 
  </parameter> 
  <parameter> 
    <name value="return"/> 
    <use value="out"/> 
    <min value="1"/> 
    <max value="1"/> 
    <documentation value="The bundle containing the composition and resources associated with it. See [FHIR
     Documents](documents.html) for information on resources that may be included in
     the bundle."/> 
    <type value="Bundle"/> 
  </parameter> 
</OperationDefinition>