Operation-composition-document.json

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "Composition-document",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/Composition-document",
  "name": "Generate a Document",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "A client can ask a server to generate a fully bundled document from a composition resource.\nThe server takes the composition resource, locates all the referenced resources and other\nadditional resources as configured or requested and either returns a full document bundle,\nor returns an error. Note that since this is a search operation, the document bundle is \nwrapped inside the search bundle.\n\nIf some of the resources are located on other servers, it is at the discretion of the \nserver whether to retrieve them or return an error. If the correct version of the document \nthat would be generated already exists, then the server can return the existing one.",
  "status": "draft",
  "date": "2015-02-23T09:07:27+11:00",
  "kind": "operation",
  "code": "document",
  "system": false,
  "type": [
    "Composition"
  ],
  "instance": false,
  "parameter": [
    {
      "name": "persist",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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": "boolean"
    },
    {
      "name": "cert",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Certificate URL to use to sign the document with. The certificate should be associated with one of the attestors",
      "type": "string"
    },
    {
      "name": "pword",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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": "string"
    }
  ]
}