CarePlan read

get/CarePlan/{id}
Page View

This resource contains the treatment plan for a patient, whether upcoming or past. Or, it can be used for public health use cases to describe care for a group or community through targeted campaigns. 

You can review or retrieve care plan information.

read

This interaction allows you to review a specific CarePlan resource with details about a patient's current, future, or historical plans.

Request parameters

cURL request example

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

Request Parameters

  • id
    required, string

    CarePlan identifier

Response fields and example

Example payload generated from schema
1
{
2
"resourceType": "CarePlan",
3
"text": {
4
"status": "generated",
5
"div": null
6
},
7
"status": "draft",
8
"intent": "proposal",
9
"category": [
10
{
11
"coding": [
12
{
13
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
14
"code": "assess-plan"
15
}
16
]
17
}
18
],
19
"subject": null
20
}
  • resourceType
    required, string

    Identifies the type of the resource

    Value: CarePlan
  • text
    required, object

    A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

    • status
      required, string

      The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

      Possible Values: generated, extensions, additional, empty
    • div
      required, 

      The actual narrative content, a stripped down version of XHTML.

  • status
    required, string

    Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

    Possible Values: draft, active, on-hold, revoked, completed, entered-in-error, unknown
  • intent
    required, string

    Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

    Possible Values: proposal, plan, order, option
  • category
    required, Array of AssessPlan or Other

    Type of plan.

    • coding
      required, Array of object
      • system
        required, string
        Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category
      • code
        required, string
        Value: assess-plan
  • subject
    required, object

    Who care plan is for.

    Must be a resource of type Patient.

    • id
      string

      A sequence of Unicode characters

    • extension
      Array of object

      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.

      • id
        string

        A sequence of Unicode characters

      • url
        string

        String of characters used to identify a name or a resource

      • valueBase64Binary
        string

        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    • reference
      string

      A sequence of Unicode characters

    • _reference
      object

      Extensions for reference

      • id
        string

        A sequence of Unicode characters

      • extension
        Array of object

        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.

        • id
          string

          A sequence of Unicode characters

        • url
          string

          String of characters used to identify a name or a resource

        • valueBase64Binary
          string

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    • type
      string

      String of characters used to identify a name or a resource

    • _type
      object

      Extensions for type

      • id
        string

        A sequence of Unicode characters

      • extension
        Array of object

        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.

        • id
          string

          A sequence of Unicode characters

        • url
          string

          String of characters used to identify a name or a resource

        • valueBase64Binary
          string

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    • identifier
      object

      An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

      • id
        string

        A sequence of Unicode characters

      • extension
        Array of object

        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.

        • id
          string

          A sequence of Unicode characters

        • url
          string

          String of characters used to identify a name or a resource

        • valueBase64Binary
          string

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • use

        The purpose of this identifier.

        Possible Values: usual, official, temp, secondary, old
      • _use
        object

        Extensions for use

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          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.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • type
        object

        A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          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.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            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.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • system
            string

            String of characters used to identify a name or a resource

          • _system
            object

            Extensions for system

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              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.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • version
            string

            A sequence of Unicode characters

          • _version
            object

            Extensions for version

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              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.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • code
            string

            A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

          • _code
            object

            Extensions for code

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              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.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • display
            string

            A sequence of Unicode characters

          • _display
            object

            Extensions for display

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              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.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          • userSelected
            boolean

            Value of "true" or "false"

          • _userSelected
            object

            Extensions for userSelected

            • id
              string

              A sequence of Unicode characters

            • extension
              Array of object

              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.

              • id
                string

                A sequence of Unicode characters

              • url
                string

                String of characters used to identify a name or a resource

              • valueBase64Binary
                string

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • text
          string

          A sequence of Unicode characters

        • _text
          object

          Extensions for text

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            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.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • system
        string

        String of characters used to identify a name or a resource

      • _system
        object

        Extensions for system

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          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.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • value
        string

        A sequence of Unicode characters

      • _value
        object

        Extensions for value

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          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.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • period
        object

        Time period during which identifier is/was valid for use.

        • id
          string

          A sequence of Unicode characters

        • extension
          Array of object

          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.

          • id
            string

            A sequence of Unicode characters

          • url
            string

            String of characters used to identify a name or a resource

          • valueBase64Binary
            string

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • start
          string

          A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

        • _start
          object

          Extensions for start

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            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.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        • end
          string

          A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

        • _end
          object

          Extensions for end

          • id
            string

            A sequence of Unicode characters

          • extension
            Array of object

            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.

            • id
              string

              A sequence of Unicode characters

            • url
              string

              String of characters used to identify a name or a resource

            • valueBase64Binary
              string

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    • display
      string

      A sequence of Unicode characters

    • _display
      object

      Extensions for display

      • id
        string

        A sequence of Unicode characters

      • extension
        Array of object

        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.

        • id
          string

          A sequence of Unicode characters

        • url
          string

          String of characters used to identify a name or a resource

        • valueBase64Binary
          string

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).