Operation
Definition
for
Code
System
MedicationRequestIntent
proposal
The request is a suggestion made by someone/something that doesn't have an intention to
ensure it occurs and without providing an authorization to act
plan
The request represents an intension to ensure something occurs without providing an authorization
for others to act
order
instance-order
The request represents an instance for the particular order, for example a medication
administration record.
The request is a suggestion made by someone/something that doesn't have an intention to
ensure it occurs and without providing an authorization to act
The request represents an intension to ensure something occurs without providing an authorization
for others to act
The request represents an instance for the particular order, for example a medication
administration record.
</
CodeSystem
>
{
"resourceType" : "OperationDefinition",
"id" : "DocumentReference-generate",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><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>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>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>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>docRef</td><td>0..1</td><td><a href=\"documentreference.html\">DocumentReference</a></td><td/><td><div><p>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.</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/OperationDefinition/DocumentReference-generate",
"version" : "5.0.0-ballot",
"name" : "Generate",
"title" : "Generate a DocumentReference from a document",
"status" : "draft",
"kind" : "operation",
"experimental" : false,
"date" : "2022-09-10T04:52:37+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:",
"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" : "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"
}]
}
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.