FHIR © HL7.org  |  Server Home  |  Health Intersections FHIR Server v1.0.287  |  FHIR Version 4.0.0  | User: ANONYMOUS (Unknown)  

Resource "List-find" Version "1" (OperationDefinition)

Tags:

XML or JSON representation . provenance for this resource

Find a functional list

OPERATION: Find a functional list

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/List-find

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. 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)

URL: [base]/List/$find

Parameters

Use Name Cardinality Type Binding Documentation
IN patient 1..1 id

The id of a patient resource located on the server on which this operation is executed

IN name 1..1 code

The code for the functional list that is being found

Note that servers may support searching by a functional list, and not support this operation that allows clients to find the list directly


{
  "resourceType" : "OperationDefinition",
  "id" : "List-find",
  "meta" : {
    "versionId" : "1",
    "lastUpdated" : "2018-12-14T02:02:43.848Z"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>Find a functional list</h2>\n <p>OPERATION: Find a functional list</p>\n <p>The official URL for this operation definition is: </p>\n <pre>http://hl7.org/fhir/OperationDefinition/List-find</pre>\n <div>\n <p>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 \n <a href=\"lifecycle.html#lists\">Current Resource Lists</a>. 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)\n </p>\n\n </div>\n <p>URL: [base]/List/$find</p>\n <p>Parameters</p>\n <table class=\"grid\">\n <tr>\n <td>\n <b>Use</b>\n </td>\n <td>\n <b>Name</b>\n </td>\n <td>\n <b>Cardinality</b>\n </td>\n <td>\n <b>Type</b>\n </td>\n <td>\n <b>Binding</b>\n </td>\n <td>\n <b>Documentation</b>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>patient</td>\n <td>1..1</td>\n <td>\n <a href=\"datatypes.html#id\">id</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The id of a patient resource located on the server on which this operation is executed</p>\n\n </div>\n </td>\n </tr>\n <tr>\n <td>IN</td>\n <td>name</td>\n <td>1..1</td>\n <td>\n <a href=\"datatypes.html#code\">code</a>\n </td>\n <td/>\n <td>\n <div>\n <p>The code for the functional list that is being found</p>\n\n </div>\n </td>\n </tr>\n </table>\n <div>\n <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\n </div>\n </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" : "4.0.0",
  "name" : "Find a functional list",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2018-12-14T01:14:32+00: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"
    }
  ]
}