Operation-documentreference-generate.json

Operation Definition

{
  "resourceType" : "OperationDefinition",
  "id" : "DocumentReference-generate",
  "text" : {
    "status" : "extensions",
    "div" : "<div>!-- Snipped for Brevity --></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 3
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  }],
  "url" : "http://hl7.org/fhir/OperationDefinition/DocumentReference-generate",
  "version" : "4.5.0",
  "name" : "Generate a DocumentReference from a document",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2020-08-20T17:41:31+10:00",
  "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 document reference from a document.\nThe server reads the existing document and generates a matching DocumentReference\nresource, or returns one it has previously generated. Servers may be able to \nreturn or generate document references for the following types of content:",
  "code" : "generate",
  "comment" : "The server either returns a search result containing a single document reference, \nor it returns an error. \nIf the URI refers to another server, it is at the discretion of the \nserver whether to retrieve it or return an error.",
  "resource" : ["DocumentReference"],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [{
    "name" : "url",
    "use" : "in",
    "min" : 1,
    "max" : "1",
    "type" : "uri"
  },
  {
    "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 (default is for the server to decide).",
    "type" : "Binary"
  },
  {
    "name" : "docRef",
    "use" : "out",
    "min" : 0,
    "max" : "1",
    "documentation" : "The server either returns a single document reference, or it returns an error. If the input url refers to another server, it is at the discretion of the server whether to retrieve it or return an error.",
    "type" : "DocumentReference"
  }]
}