Operation Definition
{
"resourceType" : "OperationDefinition",
"id" : "List-find",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/List/$find</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>patient</td><td/><td>1..1</td><td><a href=\"datatypes.html#id\">id</a></td><td/><td><div><p>The id of a patient resource located on the server on which this operation is executed</p>\n</div></td></tr><tr><td>IN</td><td>name</td><td/><td>1..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>The code for the functional list that is being found</p>\n</div></td></tr></table><div><p>Note that servers may support searching by a functional list, and not support this operation that allows clients to find the list directly</p>\n</div></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/List-find",
"version" : "5.0.0",
"name" : "Find",
"title" : "Find a functional list",
"status" : "draft",
"kind" : "operation",
"experimental" : false,
"date" : "2023-03-26T15:21:02+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "fhir@lists.hl7.org"
}]
}],
"description" : "This operation allows a client to find an identified list for a particular function by its function. The operation takes two parameters, the identity of a patient, and the name of a functional list. The list of defined functional lists can be found at [Current Resource Lists](lifecycle.html#lists). Applications are not required to support all the lists, and may define additional lists of their own. If the system is able to locate a list that serves the identified purpose, it returns it as the body of the response with a 200 OK status. If the resource cannot be located, the server returns a 404 not found (optionally with an OperationOutcome resource)",
"jurisdiction" : [{
"coding" : [{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}]
}],
"affectsState" : false,
"code" : "find",
"comment" : "Note that servers may support searching by a functional list, and not support this operation that allows clients to find the list directly",
"resource" : ["List"],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [{
"name" : "patient",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The id of a patient resource located on the server on which this operation is executed",
"type" : "id"
},
{
"name" : "name",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The code for the functional list that is being found",
"type" : "code"
}]
}
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.