FHIR © HL7.org  |  Server Home  |  Health Intersections FHIR Server v1.0.288  |  FHIR Version 1.0.2  | User: ANONYMOUS (Unknown)  

Resource "Composition-document" Version "1" (OperationDefinition)

Tags:

XML or JSON representation . provenance for this resource

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.

URL: [base]/Composition/$document

Parameters

Use Name Cardinality Type Binding Documentation
IN persist 0..1 boolean

Whether to store the document at the binary end-point (/Binary) or not once it is generated. Value = true or false (default is for the server to decide)

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


<?xml version="1.0" encoding="UTF-8"?>
<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Composition-document"/>
  <meta>
    <versionId value="1"/>
    <lastUpdated value="2018-09-06T12:32:36.719Z"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Generate a Document</h2>
      <p>OPERATION: Generate a Document</p>
      <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>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 binary end-point (/Binary) or not once it is generated. Value = true or false (default is for the server to decide)</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"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <date value="2015-10-24T07:41:03+11:00"/>
  <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"/>
  <notes 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"/>
  <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 binary end-point (/Binary) or not once it is generated. Value = true or false (default is for the server to decide)"/>
    <type value="boolean"/>
  </parameter>
</OperationDefinition>