This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
. Page versions: R5 R4B R4 R3 R2
Operation Definition
{
"resourceType": "OperationDefinition",
"id": "List-find",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/List-find",
"name": "Find a functional list",
"status": "draft",
"kind": "operation",
"date": "2016-12-06T12:22:34+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)",
"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.