FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.api-incubator
Resource TypeOperationDefinition
IdOperationDefinition-List-find.json
FHIR VersionR6
Sourcehttps://build.fhir.org/ig/HL7/api-incubator-ig/OperationDefinition-List-find.html
URLhttp://hl7.org/fhir/OperationDefinition/List-find
Version0.1.0
Statusactive
Date2021-01-05T10:01:24+11:00
NameFind
TitleFind a functional list
Realmuv
Authorityhl7
DescriptionThis 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](https://hl7.org/fhir/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)
Typetrue
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition List-find

Last updated: 2021-01-05 10:01:24+1100

URL: [base]/List/$find

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INpatient1..1id

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

INname1..1code

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


Source1

{
  "resourceType": "OperationDefinition",
  "id": "List-find",
  "meta": {
    "lastUpdated": "2021-01-05T10:01:24.148+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    },
    {
      "extension": [
        {
          "url": "list",
          "valueString": "1"
        },
        {
          "url": "response",
          "valueBoolean": false
        },
        {
          "url": "content",
          "valueString": "$find-request.txt"
        }
      ],
      "url": "http://hl7.org/fhir/build/StructureDefinition/example"
    },
    {
      "extension": [
        {
          "url": "list",
          "valueString": "1"
        },
        {
          "url": "response",
          "valueBoolean": true
        },
        {
          "url": "content",
          "valueString": "$find-response.txt"
        }
      ],
      "url": "http://hl7.org/fhir/build/StructureDefinition/example"
    },
    {
      "url": "http://hl7.org/fhir/build/StructureDefinition/footer",
      "valueMarkdown": "Note that servers may support searching by a functional list, and not support this operation that allows clients to find the list directly"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    }
  ],
  "url": "http://hl7.org/fhir/OperationDefinition/List-find",
  "version": "0.1.0",
  "name": "Find",
  "title": "Find a functional list",
  "status": "active",
  "kind": "operation",
  "date": "2021-01-05T10:01:24+11:00",
  "publisher": "HL7 International / FHIR Infrastructure",
  "contact": [
    {
      "name": "HL7 International / FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "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](https://hl7.org/fhir/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"
    }
  ]
}