This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Orders and Observations Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw JSON (canonical form + also see JSON Format Specification)
Operation Definition
{ "resourceType" : "OperationDefinition", "id" : "DocumentReference-generate", "text" : { "status" : "generated", "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition DocumentReference-generate</b></p><a name=\"DocumentReference-generate\"> </a><a name=\"hcDocumentReference-generate\"> </a><a name=\"DocumentReference-generate-en-US\"> </a><p>URL: [base]/DocumentReference/$generate</p><p>Parameters</p><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>url</td><td/><td>1..1</td><td><a href=\"datatypes.html#uri\">uri</a></td><td/><td><div><p>The URL to the source document. This may be a general URL or a Binary or a Composition or a Bundle.</p>\n</div></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 document end-point (/Document) or not, once it is generated (default is for the server to decide).</p>\n</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 type is "searchset"containing <a href=\"documentreference.html\">DocumentReference</a> resource and may include a Binary. If the input url refers to another server, it is at the discretion of the server whether to retrieve it or return an error.</p>\n</div></td></tr></table><div><p>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.</p>\n</div></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/StructureDefinition/structuredefinition-wg", "valueCode" : "oo" }], "url" : "http://hl7.org/fhir/OperationDefinition/DocumentReference-generate", "version" : "6.0.0-ballot1", "name" : "Generate", "title" : "Generate a DocumentReference from a document", "status" : "draft", "kind" : "operation", "experimental" : false, "date" : "2024-08-12T01:54:17+00:00", "publisher" : "HL7 International / Orders and Observations", "contact" : [{ "telecom" : [{ "system" : "url", "value" : "http://hl7.org/fhir" }, { "system" : "email", "value" : "fhir@lists.hl7.org" }] }, { "telecom" : [{ "system" : "url", "value" : "http://www.hl7.org/Special/committees/orders" }] }], "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:", "jurisdiction" : [{ "coding" : [{ "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm", "code" : "001", "display" : "World" }] }], "affectsState" : true, "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", "documentation" : "The URL to the source document. This may be a general URL or a Binary or a Composition or a Bundle.", "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" : "boolean" }, { "name" : "return", "use" : "out", "min" : 1, "max" : "1", "documentation" : "The bundle type is \"searchset\"containing [DocumentReference](documentreference.html) resource and may include a Binary. 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" : "Bundle" }] }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot1 generated on Mon, Aug 12, 2024 02:16+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change