EpisodeOfCare read

get/EpisodeOfCare/{id}

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.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

read

Review a specific Episode of Care resource with details about a given period of time when a provider had responsibility for some aspect of patient care.

FHIR read

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Typically, you should use the more flexible _search with query parameters, unless you're guaranteed to request data directly from a FHIR® server using the resource ID. Learn more about using FHIR® identifiers.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/EpisodeOfCare/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

id
required, string
EpisodeOfCare identifier

Response fields and example

json

1
{}

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.
  One of:
  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.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.