Home
API reference
FHIR® API
FHIR® resources
Condition
_search

Condition _search

post/Condition/_search
Page View

This resource contains details of a clinical diagnosis, problem, or other concept that needs to be conveyed for context about a patient’s wellness. This could be sent before a patient visit or received as a follow-up. A condition may or may not be related to a specific encounter and may be active, resolved, or recurring.

You can review or retrieve condition information.

_search

Query for a patient’s clinical information from one provider.

This is a flexible option with query parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

Request parameters and payload

cURL request example

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

Request Body Schema

  • category
    Array of string

    The category of the condition

  • clinical-status
    Array of string

    active | recurrence | relapse | inactive | remission | resolved

  • encounter
    Array of string

    The encounter associated with the condition

  • patient
    Array of string

    Who has the condition?

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • recorded-date
    Array of string

    The date on which the condition was recorded

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": "Condition",
9
        "id": "RedoxProblemConditionExamplePneumonia",
10
        "category": [
11
          {
12
            "coding": [
13
              {
14
                "code": "problem-list-item",
15
                "system": "http://terminology.hl7.org/CodeSystem/condition-category"
16
              }
17
            ]
18
          }
19
        ],
20
        "identifier": [
21
          {
22
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.768076",
23
            "value": "1248190455"
24
          }
25
        ],
26
        "subject": {
27
          "reference": "Patient/RedoxPatientExampleTimothy"
28
        },
29
        "clinicalStatus": {
30
          "coding": [
31
            {
32
              "code": "resolved",
33
              "system": "http://terminology.hl7.org/CodeSystem/condition-clinical"
34
            }
35
          ]
36
        },
37
        "code": {
38
          "coding": [
39
            {
40
              "code": "233604007",
41
              "system": "http://snomed.info/sct"
42
            }
43
          ],
44
          "text": "Pneumonia"
45
        },
46
        "onsetDateTime": "2012-08-06T04:00:00.000Z",
47
        "abatementDateTime": "2012-08-06T04:00:00.000Z"
48
      },
49
      "search": {
50
        "mode": "match"
51
      }
52
    }
53
  ]
54
}

    Response to a Condition 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 Condition or Other

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

    • resource
      required, object

      A clinical condition, problem, diagnosis, health concern, or other event, situation, issue, or clinical concept that has risen to a level of concern.

      • resourceType
        required, string

        Identifies the type of the resource

        Value: Condition
      • category
        required, Array of us-core or Other

        A category assigned to the condition.

          Categorizes this Condition as an entry on the patient's problem list

        • coding
          required, Array of object

          A reference to a code defined by a terminology system.

          • code
            required, 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).

            Value: problem-list-item
          • system
            required, string

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

            Value: http://terminology.hl7.org/CodeSystem/condition-category
        • 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.

      • code
        required, object

        Identification of the condition, problem or diagnosis.

        • extension
          Array of OriginalText or Other

          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.

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

            See http://hl7.org/fhir/StructureDefinition/originalText for more information

          • url
            required, string

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

            Value: http://hl7.org/fhir/StructureDefinition/originalText
          • valueString
            required, string

            The original text

        • 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
        required, object

        Indicates the patient or group who the condition record is associated with.

        Must be a resource of type Patient.

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

      • id
        string

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

      • identifier
        Array of object

        Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

        • extension
          Array of Boolean, String, CodeableConcept, Coding, HumanName or Reference

          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.

      • clinicalStatus
        string

        The clinical status of the condition.

        Possible Values: active, recurrence, relapse, inactive, remission, resolved
      • verificationStatus
        string

        The verification status to support the clinical status of the condition.

        Possible Values: unconfirmed, provisional, differential, confirmed, refuted, entered-in-error
      • severity
        object

        A subjective assessment of the severity of the condition as evaluated by the clinician.

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

      • encounter
        object

        The Encounter during which this Condition was created or to which the creation of this record is tightly associated.

        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.

      • recordedDate
        string

        The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.

      • recorder
        object

        Individual who recorded the record and takes responsibility for its content.

        Must reference one of the following types of resources:

        • Practitioner
        • PractitionerRole
        • Patient
        • RelatedPerson
        • 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.

      • note
        Array of object

        Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.

        • text
          required, string

          The text of the annotation in markdown format.

      • onsetDateTime
        string

        Estimated or actual date or date-time the condition began, in the opinion of the clinician.

      • abatementDateTime
        string

        The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate.

    • search
      required, object

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

      • mode
        required, string

        Identifies the Condition as matching the search parameters

        Value: match