Home
API reference
FHIR® API
FHIR® resources
EpisodeOfCare
_search

EpisodeOfCare _search

post/EpisodeOfCare/_search
Page View

This resource contains recorded details about a patient’s association with a healthcare provider for a period of time. Typically, this is a period when the provider has some level of responsibility for patient care regarding a specific condition or problem, even if the provider isn’t currently participating in an encounter.

You can review or retrieve episode of care information.

_search

Query for details about an episode of care for a patient from one organization.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/EpisodeOfCare/_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 'type=string' \
8
--data-urlencode 'date=string'

Request Body Schema

  • patient
    Array of string

    The patient to whom the episode of care pertains

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • type
    Array of string

    The type of episode of care

  • date
    Array of string

    The provided date search value falls within the episode of care's period

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": "EpisodeOfCare",
9
        "id": "current-episode-of-care",
10
        "identifier": [
11
          {
12
            "use": "usual",
13
            "system": "http://example.org/sampleepisodeofcare-identifier",
14
            "value": "1238141"
15
          }
16
        ],
17
        "status": "active",
18
        "statusHistory": [
19
          {
20
            "status": "planned",
21
            "period": {
22
              "start": "2021-06-17T20:33:22.422Z",
23
              "end": "2021-06-17T20:33:22.422Z"
24
            }
25
          }
26
        ],
27
        "type": [
28
          {
29
            "coding": [
30
              {
31
                "system": "http://terminology.hl7.org/CodeSystem/episodeofcare-type",
32
                "code": "hacc",
33
                "display": "Home and Community Care"
34
              }
35
            ]
36
          }
37
        ],
38
        "diagnosis": [
39
          {
40
            "condition": {
41
              "reference": "Condition/RedoxConditionExampleEncounterDx"
42
            }
43
          }
44
        ],
45
        "patient": {
46
          "reference": "Patient/RedoxPatientExampleTimothy"
47
        },
48
        "managingOrganization": {
49
          "reference": "Organization/RedoxOrganizationManagingExample"
50
        },
51
        "period": {
52
          "start": "2021-06-17T20:33:22.422Z",
53
          "end": "2021-06-17T20:33:22.422Z"
54
        },
55
        "referralRequest": [
56
          {
57
            "reference": "RedoxServiceRequestExample"
58
          }
59
        ],
60
        "careManager": {
61
          "reference": "Practitioner/RedoxPractitionerExamplePat"
62
        },
63
        "team": [
64
          {
65
            "reference": "CareTeam/RedoxCareTeamExample"
66
          }
67
        ],
68
        "account": [
69
          {
70
            "reference": "RedoxAccountExample"
71
          }
72
        ]
73
      },
74
      "search": {
75
        "mode": "match"
76
      }
77
    }
78
  ]
79
}

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

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

    • resource
      required, object

      Search results for a search on the EpisodeOfCare resource.

      • resourceType
        required, string

        Identifies the type of the resource

        Value: EpisodeOfCare
      • status
        required, string

        planned | waitlist | active | onhold | finished | cancelled.

        Possible Values: planned, waitlist, active, onhold, finished, cancelled, entered-in-error
      • patient
        required, object

        The patient who is the focus of this episode of care.

        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

        The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.

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

      • statusHistory
        Array of object

        The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).

        • status
          required, string

          planned | waitlist | active | onhold | finished | cancelled.

          Possible Values: planned, waitlist, active, onhold, finished, cancelled, entered-in-error
        • period
          required, object

          The period during this EpisodeOfCare that the specific status applied.

          • start
            string

            The start of the period. The boundary is inclusive.

          • end
            string

            The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

      • type
        Array of object

        A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.

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

      • diagnosis
        Array of object

        The list of diagnosis relevant to this episode of care.

        • condition
          required, object

          A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.

          Must be a resource of type Condition.

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

      • managingOrganization
        object

        The organization that has assumed the specific responsibilities for the specified duration.

        Must be a resource of type Organization.

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

      • period
        object

        The interval during which the managing organization assumes the defined responsibility.

        • start
          string

          The start of the period. The boundary is inclusive.

        • end
          string

          The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

      • referralRequest
        Array of object

        Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.

        Must be a resource of type ServiceRequest.

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

      • careManager
        object

        The practitioner that is the care manager/care coordinator for this patient.

        Must be a resource of type Practitioner.

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

      • team
        Array of object

        The list of practitioners that may be facilitating this episode of care for specific purposes.

        Must be a resource of type CareTeam.

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

      • account
        Array of object

        The set of accounts that may be used for billing for this EpisodeOfCare.

        Must be a resource of type Account.

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

    • search
      required, object

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

      • mode
        required, string

        Identifies the EpisodeOfCare as matching the search parameters

        Value: match