Home
API reference
FHIR® API
FHIR® resources
List
_search

List _search

post/List/_search
Page View

This resource contains an ordered collection of clinical resources. Typically, this is a list that a practitioner could attest to and is a more curated clinical guide than a list of results from a search query. List is available for FHIR® passthrough cases.

You can review or retrieve clinical lists.

_search

Query for a list of related clinical resources.

The query response may contain a set of only one type of resource (e.g., only AllergyIntolerance resources) or different resource types (e.g., a mix of AllergyIntolerance, Condition, and Procedure resources). Alternatively, the query response may contain a list of curated, current records, whereas a search response for a specific resource (e.g., AllergyIntolerance_search) may include duplicate or outdated results.

Work with your connection to understand what the List response includes, since this option is best for FHIR® passthrough.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/List/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'patient=string' \
6
--data-urlencode 'patient.identifier=string' \
7
--data-urlencode 'encounter=string' \
8
--data-urlencode 'encounter.identifier=string' \
9
--data-urlencode 'code=string'

Request Body Schema

  • patient
    Array of string

    The patient to whom the list pertains

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • encounter
    Array of string

    The encounter to whom the list pertains

  • encounter.identifier
    Array of string

    Identifier(s) by which this encounter is known

  • code
    Array of string

    The purpose of the list

Response fields and example

Example payload generated from schema
1
{
2
  "resourceType": "Bundle",
3
  "type": "searchset",
4
  "total": 1,
5
  "entry": [
6
    {
7
      "resource": {
8
        "resourceType": "List",
9
        "id": "current-allergies-list",
10
        "extension": [
11
          {
12
            "url": "http://hl7.org/fhir/StructureDefinition/list-for",
13
            "valueReference": {
14
              "reference": "Patient/RedoxPatientExampleTimothy",
15
              "display": "Timothy Bixby"
16
            }
17
          }
18
        ],
19
        "status": "current",
20
        "mode": "working",
21
        "title": "Current Allergy List",
22
        "code": {
23
          "coding": [
24
            {
25
              "code": "52472-8",
26
              "system": "http://loinc.org",
27
              "display": "Allergies and Adverse Drug Reactions"
28
            }
29
          ],
30
          "text": "Current Allergy List"
31
        },
32
        "date": "2015-07-14T23:10:23+11:00",
33
        "source": {
34
          "reference": "Patient/RedoxPatientExampleTimothy",
35
          "display": "Timothy Bixby"
36
        },
37
        "orderedBy": {
38
          "coding": [
39
            {
40
              "code": "entry-date",
41
              "system": "http://terminology.hl7.org/CodeSystem/list-order"
42
            }
43
          ]
44
        },
45
        "entry": [
46
          {
47
            "item": {
48
              "reference": "AllergyIntolerance/AllergyExample"
49
            }
50
          },
51
          {
52
            "item": {
53
              "reference": "AllergyIntolerance/AllergyExampleSulfonamide"
54
            }
55
          }
56
        ]
57
      },
58
      "search": {
59
        "mode": "match"
60
      }
61
    }
62
  ]
63
}

    Response to a List search operation

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a response to a search

    Value: searchset
  • total
    required, number

    The total number of matches

  • entry
    Array of List or Other

    A resource matching the search criteria or related to a matching resource

    • resource
      required, object

      Search results for a search on the List resource.

      • resourceType
        required, string

        Identifies the type of the resource

        Value: List
      • status
        required, string

        Indicates the current state of this list.

        Possible Values: current, retired, entered-in-error
      • mode
        required, string

        How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

        Possible Values: working, snapshot, changes
      • id
        string

        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • extension
        Array of Boolean, String, CodeableConcept, Coding

        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        • url
          required, string

          Source of the definition for the extension code - a logical name or a URL.

        • valueBoolean
          boolean

          A single value for the extension.

      • identifier
        Array of object

        Identifier for the List assigned for business purposes outside the context of FHIR.

        • extension
          Array of Boolean, String, CodeableConcept, Coding

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

          • valueBoolean
            boolean

            A single value for the extension.

        • use
          string

          The purpose of this identifier.

          Possible Values: usual, official, temp, secondary, old (If known)
        • system
          string

          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

        • value
          string

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

      • title
        string

        A label for the list assigned by the author.

      • code
        object

        This code defines the purpose of the list - why it was created.

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • subject
        object

        The common subject (or patient) of the resources that are in the list if there is one.

        Must reference one of the following types of resources:

        • Patient
        • Group
        • Device
        • Location
        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • encounter
        object

        The encounter that is the context in which this list was created.

        Must be a resource of type Encounter.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • date
        string

        The date that the list was prepared.

      • source
        object

        The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.

        Must reference one of the following types of resources:

        • Practitioner
        • PractitionerRole
        • Patient
        • Device
        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • orderedBy
        object

        What order applies to the items in the list.

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • entry
        Array of object

        Entries in this list.

        • item
          required, object

          A reference to the actual resource from which data was derived.

          Must be a resource of type Resource.

          • reference
            string

            A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

        • flag
          object

          The flag allows the system constructing the list to indicate the role and significance of the item in the list.

          • coding
            Array of object

            A reference to a code defined by a terminology system.

            • system
              string

              The identification of the code system that defines the meaning of the symbol in the code.

            • code
              string

              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

          • text
            string

            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

        • deleted
          boolean

          True if this item is marked as deleted in the list.

        • date
          string

          When this item was added to the list.

      • emptyReason
        object

        If the list is empty, why the list is empty.

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

    • search
      required, object

      Information about the search process that lead to the creation of this entry.

      • mode
        required, string

        Identifies the List as matching the search parameters

        Value: match