This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

4.3.5 Resource CarePlan - Examples

Example Index:

General Person ExampleXMLJSON
Patient 1 for linkingXMLJSON
Simple integrated care plan with multiple goals & conditions (from Mayo)XMLJSON
Encounter to GP (Primary care Practitioner)XMLJSON
Real-world patient exampleXMLJSON
Real-world patient exampleXMLJSON
Real-world patient exampleXMLJSON
Real-world patient exampleXMLJSON
Real-world patient exampleXMLJSON
Real-world patient exampleXMLJSON

4.3.5.1 Weight Loss

XML

General Person Example (id = "example")

Raw XML

<CarePlan xmlns="http://hl7.org/fhir">
    <text>
        <status value="additional"/>
        <div xmlns="http://www.w3.org/1999/xhtml">
           <p> A simple care plan to indicate a patient taking their weight once a day because of obesity.
            Some Notes: </p>
            <ul>
            <li>It would be good to have some way of specifying/coding a goal. e.g. what the target weight
           is</li>
            <li>In the codeable concepts I've been lazy and just put the text. There should, of course,
           be a code behind these</li>
        </ul>
        </div>
    </text>
    <contained>
      <Condition id="p1">
        <subject>
          <reference value="Patient/example"/>
          <display value="Peter James Chalmers"/>
        </subject>
        <code>
          <text value="Obesity"/>
        </code>
        <status value="confirmed"/>
      </Condition>
    </contained>
    <contained>
      <Practitioner id="pr1">
          <name>
            <family value="Dietician"/>
            <given value="Dorothy"/>
          </name>
        
        <specialty>
          <text value="Dietician"/>
        </specialty>
      </Practitioner>
    </contained>
    <patient>
        <reference value="Patient/example"/>
        <display value="Peter James Chalmers"/>
    </patient>
    <status value="active"/>
    <period>
      <end value="2013-01-01"/>
    </period>
    <concern>
        <reference value="#p1"/>
        <display value="obesity"/>
    </concern>
    <participant>
        <role>
            <text value="responsiblePerson"/>
        </role>
        <member>
          <reference value="Patient/example"/>
          <display value="Peter James Chalmers"/>
        </member>
    </participant>
    <participant>
        <role>
            <text value="adviser"/>
        </role>
        <member>
            <reference value="#pr1"/>
            <display value="Dorothy Dietition"/>
        </member>
    </participant>
    <goal>
      <description value="Target weight is 80 kg. Note: be nice if this could be coded"/>
    </goal>
    <activity>
        <prohibited value="false"/>
      <simple>
        <category value="observation"/>
        <code>
            <text value="a code for weight measurement"/>
        </code>
        <timingSchedule>
            <repeat>
                <frequency value="1"/>
                <duration value="1"/>
                <units value="d"/>
            </repeat>
        </timingSchedule>
        <performer>
          <reference value="Patient/example"/>
          <display value="Peter James Chalmers"/>
        </performer>
      </simple>
    </activity>
</CarePlan>

JSON

General Person Example

{
  "resourceType": "CarePlan",
  "text": {
    "status": "additional",
    "div": "<div>\n           <p> A simple care plan to indicate a patient taking their weight once a day because of obesity.\n            Some Notes: </p>\n            <ul>\n            <li>It would be good to have some way of specifying/coding a goal. e.g. what the target weight is</li>\n            <li>In the codeable concepts I've been lazy and just put the text. There should, of course, be a code behind these</li>\n        </ul>\n        </div>"
  },
  "contained": [
    {
      "resourceType": "Condition",
      "id": "p1",
      "subject": {
        "reference": "Patient/example",
        "display": "Peter James Chalmers"
      },
      "code": {
        "text": "Obesity"
      },
      "status": "confirmed"
    },
    {
      "resourceType": "Practitioner",
      "id": "pr1",
      "name": {
        "family": [
          "Dietician"
        ],
        "given": [
          "Dorothy"
        ]
      },
      "specialty": [
        {
          "text": "Dietician"
        }
      ]
    }
  ],
  "patient": {
    "reference": "Patient/example",
    "display": "Peter James Chalmers"
  },
  "status": "active",
  "period": {
    "end": "2013-01-01"
  },
  "concern": [
    {
      "reference": "#p1",
      "display": "obesity"
    }
  ],
  "participant": [
    {
      "role": {
        "text": "responsiblePerson"
      },
      "member": {
        "reference": "Patient/example",
        "display": "Peter James Chalmers"
      }
    },
    {
      "role": {
        "text": "adviser"
      },
      "member": {
        "reference": "#pr1",
        "display": "Dorothy Dietition"
      }
    }
  ],
  "goal": [
    {
      "description": "Target weight is 80 kg. Note: be nice if this could be coded"
    }
  ],
  "activity": [
    {
      "prohibited": false,
      "simple": {
        "category": "observation",
        "code": {
          "text": "a code for weight measurement"
        },
        "timingSchedule": {
          "repeat": {
            "frequency": 1,
            "duration": 1,
            "units": "d"
          }
        },
        "performer": [
          {
            "reference": "Patient/example",
            "display": "Peter James Chalmers"
          }
        ]
      }
    }
  ]
}

4.3.5.2 Pregnancy

XML

Patient 1 for linking (id = "preg")

Raw XML

<CarePlan xmlns="http://hl7.org/fhir">
    <!--   an extension to record the LMP, which is required at the plan level...   -->
    <extension url="http://example.org/DoNotUse/careplan#lmp">
        <valueDateTime value="2013-01-01"/>
    </extension>
 
    <text>
        <status value="additional"/>
        <div xmlns="http://www.w3.org/1999/xhtml">
            <p>A maternity care plan (for a pregnant woman).</p>           
            <p>LMP is 1st Jan, 2013 (a greaat new years party!) The plan has a scheduled first antenatal,
            and 'placeholders' for the second antenatal and delivery (there would be lots
         of others of course)</p>
            <p>Note that where is a proposed 'status' element against each activity</p>
        </div>
    </text>
    <contained>
      <Condition id="p1">
        <subject>
          <reference value="Patient/1"/>
          <display value="Eve Everywoman"/>
        </subject>
        <code>
          <text value="pregnancy"/>
        </code>
        <status value="confirmed"/>
      </Condition>
    </contained>
    <contained>
      <Practitioner id="pr1">
          <name>
            <family value="Midwife"/>
            <given value="Mavis"/>
          </name>      
        <specialty>
          <text value="Midwife"/>
        </specialty>
      </Practitioner>
    </contained>
    <contained>
      <Practitioner id="pr2">
          <name>
            <family value="Obstetrician"/>
            <given value="Oscar"/>
          </name>     
        <specialty>
          <text value="Obstetrician"/>
        </specialty>
      </Practitioner>
    </contained>
    <patient>
        <reference value="Patient/1"/>
        <display value="Eve Everywoman"/>
    </patient>
    <status value="active"/>
    <period>
        <!--   The likely duration of the pregnancy   -->
        <start value="2013-01-01"/>
        <end value="2013-10-01"/>
    </period>
    <concern>
        <reference value="#p1"/>
        <display value="pregnancy"/>
    </concern>

    <participant>
        <!--   In New Zealand, there is a Lead Maternity Carer (LMC) - often a midwife   -->
        <role>
            <coding>
                <system value="mySys"/>
                <code value="lmc"/>
            </coding>
            <text value="Midwife"/>
        </role>
        <member>
            <!--   This links to the clincian resource, so we get all the stuff related to that like address,
       contact etc...   -->
            <reference value="#pr1"/>
            <display value="Mavis Midwife"/>
        </member>
    </participant>
    <participant>
        <!--   To indicate that there is an obstretian consultant involved in this case.   -->
        <role>
            <coding>
                <system value="mySys"/>
                <code value="obs"/>
            </coding>
            <text value="Obstretitian"/>
        </role>
        <member>
            <!--   This links to the clincian resource, so we get all tha stuff related to that like address,
       contact etc...   -->
            <reference value="#pr2"/>
            <display value="Oscar Obstetrician"/>
        </member>
    </participant>
    <goal>
      <description value="Maintain a womans health throughout pregnancy and ensure a healthy child"/>
    </goal>
    <activity>
        <!--   This will be the first antenatal encounter   -->
        
        <!--   a link to further details about the first antenatal details   -->
        <extension url="http://example.org/DoNotUse/careplan#andetails">
            <valueUri value="http://orionhealth.com/fhir/careplan/1andetails"/>
        </extension>
        
        <status value="scheduled"/>
        <prohibited value="false"/>
        <simple>
        <category value="encounter"/>
        <code>
            <coding>
                <system value="mySystem"/>
                <code value="1an"/>
            </coding>
            <text value="First Antenatal encounter"/>
        </code>
        <timingSchedule>
            <!--   The encounter should occur between 14 feb and 28 feb   -->
            <event>
                <start value="2013-02-14"/>
                <end value="2013-02-28"/>
            </event>
        </timingSchedule>
        <performer>
            <reference value="#pr1"/>
            <display value="Mavis Midwife"/>
        </performer>
        <details value="The first antenatal encounter. This is where a detailed physical examination is performed.
                   and the pregnanacy discussed with the mother-to-be."/>
        <!--   This is a booked encounter with Mavis Midwife for the first antenatal checkup. 
        This entry is only made after the appointment (a planned encounter) has been made.
        Commented out for now because Encounter hasn't been defined yet
        &lt;actionTaken&gt;
            &lt;url value=&quot;xxx&quot;/&gt;
            &lt;display value=&quot;Appointment with Mavis midwife @12.30pm, 112 St albans
       Ave&quot;/&gt;
        &lt;/actionTaken&gt;  -->
        </simple>
    </activity>
    
    <activity>
        <status value="not started"/>
        <prohibited value="false"/>
        <simple>
        <!--   This will be the second antenatal encounter - 3 months after LMP. It is not yet scheduled.
         -->
        <category value="encounter"/>
        <code>
            <!--   The code is just for an antenatal encounter. There are many of these, the first is special...
           -->
            <coding>
                <system value="mySystem"/>
                <code value="an"/>
            </coding>
            <text value="Follow-up Antenatal encounter"/>           
        </code>
        <timingSchedule>
            <!--   The encounter should occur between 1 march and 14 march   -->
            <event>
                <start value="2013-03-01"/>
                <end value="2013-03-14"/>
            </event>
        </timingSchedule>
        <performer>
            <!--   The performer is known, but the actual appointment is not yet made, hence there is no
         action element...   -->
            <reference value="#pr1"/>
            <display value="Mavis Midwife"/>
        </performer>
        <details value="The second antenatal encounter. Discuss any issues that arose from the first antenatal
       encounter"/>
        </simple>
    </activity>
    <!--   
        There would be a number of other encounters to be scheduled here... 
        ...
        ...
    
      -->
    
    <activity>
        <status value="not started"/>
        <prohibited value="false"/>
        <simple>
        <!--   This will be the delivery. It is not yet scheduled.   -->
        <category value="encounter"/>
        <code>
            <coding>
                <system value="mySystem"/>
                <code value="del"/>
            </coding>
            <text value="Delivery"/>
            
        </code>
        <timingSchedule>
            <!--   The delivery should occur between 1 september and 14 september   -->
            <event>
                <start value="2013-09-01"/>
                <end value="2013-09-14"/>
            </event>
        </timingSchedule>
        <!--   Where the delivery is to occur... 
          Commented out for now because location resource isn't defined
        &lt;location&gt;
            &lt;url value=&quot;loc100&quot;/&gt;
            &lt;display value=&quot;St Albans delivery suite&quot;/&gt;
        &lt;/location&gt;  -->
        <performer>
            <!--   The intention is that Maris will be perfroming the delivery...   -->
            <reference value="#pr1"/>
            <display value="Mavis Midwife"/>
        </performer>
        <details value="The delivery."/>
        </simple>
    </activity>
    
    
</CarePlan>

JSON

Patient 1 for linking

{
  "resourceType": "CarePlan",
  "extension": [
    {
      "url": "http://example.org/DoNotUse/careplan#lmp",
      "valueDateTime": "2013-01-01"
    }
  ],
  "text": {
    "status": "additional",
    "div": "<div>\n            <p>A maternity care plan (for a pregnant woman).</p>           \n            <p>LMP is 1st Jan, 2013 (a greaat new years party!) The plan has a scheduled first antenatal,\n            and 'placeholders' for the second antenatal and delivery (there would be lots of others of course)</p>\n            <p>Note that where is a proposed 'status' element against each activity</p>\n        </div>"
  },
  "contained": [
    {
      "resourceType": "Condition",
      "id": "p1",
      "subject": {
        "reference": "Patient/1",
        "display": "Eve Everywoman"
      },
      "code": {
        "text": "pregnancy"
      },
      "status": "confirmed"
    },
    {
      "resourceType": "Practitioner",
      "id": "pr1",
      "name": {
        "family": [
          "Midwife"
        ],
        "given": [
          "Mavis"
        ]
      },
      "specialty": [
        {
          "text": "Midwife"
        }
      ]
    },
    {
      "resourceType": "Practitioner",
      "id": "pr2",
      "name": {
        "family": [
          "Obstetrician"
        ],
        "given": [
          "Oscar"
        ]
      },
      "specialty": [
        {
          "text": "Obstetrician"
        }
      ]
    }
  ],
  "patient": {
    "reference": "Patient/1",
    "display": "Eve Everywoman"
  },
  "status": "active",
  "period": {
    "start": "2013-01-01",
    "end": "2013-10-01"
  },
  "concern": [
    {
      "reference": "#p1",
      "display": "pregnancy"
    }
  ],
  "participant": [
    {
      "role": {
        "coding": [
          {
            "system": "mySys",
            "code": "lmc"
          }
        ],
        "text": "Midwife"
      },
      "member": {
        "reference": "#pr1",
        "display": "Mavis Midwife"
      }
    },
    {
      "role": {
        "coding": [
          {
            "system": "mySys",
            "code": "obs"
          }
        ],
        "text": "Obstretitian"
      },
      "member": {
        "reference": "#pr2",
        "display": "Oscar Obstetrician"
      }
    }
  ],
  "goal": [
    {
      "description": "Maintain a womans health throughout pregnancy and ensure a healthy child"
    }
  ],
  "activity": [
    {
      "extension": [
        {
          "url": "http://example.org/DoNotUse/careplan#andetails",
          "valueUri": "http://orionhealth.com/fhir/careplan/1andetails"
        }
      ],
      "status": "scheduled",
      "prohibited": false,
      "simple": {
        "category": "encounter",
        "code": {
          "coding": [
            {
              "system": "mySystem",
              "code": "1an"
            }
          ],
          "text": "First Antenatal encounter"
        },
        "timingSchedule": {
          "event": [
            {
              "start": "2013-02-14",
              "end": "2013-02-28"
            }
          ]
        },
        "performer": [
          {
            "reference": "#pr1",
            "display": "Mavis Midwife"
          }
        ],
        "details": "The first antenatal encounter. This is where a detailed physical examination is performed.             and the pregnanacy discussed with the mother-to-be."
      }
    },
    {
      "status": "not started",
      "prohibited": false,
      "simple": {
        "category": "encounter",
        "code": {
          "coding": [
            {
              "system": "mySystem",
              "code": "an"
            }
          ],
          "text": "Follow-up Antenatal encounter"
        },
        "timingSchedule": {
          "event": [
            {
              "start": "2013-03-01",
              "end": "2013-03-14"
            }
          ]
        },
        "performer": [
          {
            "reference": "#pr1",
            "display": "Mavis Midwife"
          }
        ],
        "details": "The second antenatal encounter. Discuss any issues that arose from the first antenatal encounter"
      }
    },
    {
      "status": "not started",
      "prohibited": false,
      "simple": {
        "category": "encounter",
        "code": {
          "coding": [
            {
              "system": "mySystem",
              "code": "del"
            }
          ],
          "text": "Delivery"
        },
        "timingSchedule": {
          "event": [
            {
              "start": "2013-09-01",
              "end": "2013-09-14"
            }
          ]
        },
        "performer": [
          {
            "reference": "#pr1",
            "display": "Mavis Midwife"
          }
        ],
        "details": "The delivery."
      }
    }
  ]
}

4.3.5.3 GPVisit

XML

Encounter to GP (Primary care Practitioner) (id = "gpvisit")

Raw XML

<CarePlan xmlns="http://hl7.org/fhir">
    <text>
        <status value="additional"/>
        <div xmlns="http://www.w3.org/1999/xhtml">
          <p>  Represents the flow of a patient within a practice. The plan is created when
        they arrive and represents the 'care' of the patient over the course of that encounter.
        They first see the nurse for basic observations (BP, pulse, temp) then the doctor
         for
        the consultation and finally the nurse again for a tetanus immunization. As the
         plan is
        updated (e.g. a new activity added), different versions of the plan exist, and
         workflow timings
        for reporting can be gained by examining the plan history. This example is the
         version after
        seeing the doctor, and waiting for the nurse.The plan can either be created 'ad
         hoc' and modified as
        the parient progresses, or start with a standard template (which can, of course,
         be altered to suit the patient.</p>
        </div>
    </text>
    <contained>
        <!--   This is the reason for the encounter. It is referenced by the concern   -->
        <Condition id="p1">
            <subject>
                <reference value="Patient/100"/>
                <display value="Peter James Chalmers"/>
            </subject>
            <code>
                <!--   Could coded if we wanted to...  -->
                <text value="Overseas encounter"/>
            </code>
            <status value="confirmed"/>
    </Condition>
    </contained>
    <patient>
        <reference value="Patient/100"/>
        <display value="Peter James Chalmers"/>
    </patient>
    <status value="active"/>
    <period>
        <!--   This is the time the plan started - i.e. when they arrived  -->
        <start value="2013-01-01T10:30:00+00:00"/>
        <!--   No end yet as the encounter is still in progress.  -->
    </period>
    <concern>
        <reference value="#p1"/>
        <display value="obesity"/>
    </concern>
    <participant id="part1">
        <role>
            <coding>
                <system value="local"/>
                <code value="nur"/>
            </coding>
            <text value="nurse"/>
        </role>
        <member>
            <reference value="Practitioner/13"/>
            <display value="Nurse Nancy"/>
        </member>
    </participant>
    <participant id="part2">
        <role>
            <coding>
                <system value="local"/>
                <code value="doc"/>
            </coding>
            <text value="doctor"/>
        </role>
        <member>
            <reference value="Practitioner/14"/>
            <display value="Doctor Dave"/>
        </member>
    </participant>
    
    <goal>
      <description value="Complete consultation"/>
    </goal>
    <activity>
        <status value="completed"/>
        <prohibited value="false"/>
        <actionResulting>
            <!--   This is a link to the nurse encounter. The assumption is that all contacts with practitioners
            are modelled as separate encounters. Ideally, there will be  a 'master/parent'
       encounter that ties them together.
            If there is a single encounter, then all participants will be linked to that
       encounter.  -->
            <reference value="Encounter/example"/>
        </actionResulting>
        <simple>
          <!--   This activity is for the initial nurse encounter where vitals are taken. It has been
       completed.  -->
          <category value="encounter"/>
          <code>
              <coding>
                  <system value="local"/>
                  <code value="nursecon"/>
              </coding>
              <text value="Nurse Consultation"/>
          </code>
          <timingPeriod>
              <!--   the nurse saw the patient between 10:38 and 10:50   -->
              <start value="2013-01-01T10:38:00+00:00"/>
              <end value="2013-01-01T10:50:00+00:00"/>            
          </timingPeriod>
          <performer>
              <!--   refer to the participant (the nurse) in this resource  -->
              <reference value="Practitioner/13"/>
            <display value="Nurse Nancy"/>
          </performer>
        </simple>
    </activity>
    <activity>
        <status value="scheduled"/>
        <prohibited value="false"/>
        <simple>
          <!--   This activity is for the encounter with the doctor. It is scheduled, but not yet started,
              so there is no timing[x]  or actionTaken element yet   -->
          <category value="encounter"/>
          <code>
              <coding>
                  <system value="local"/>
                  <code value="doccon"/>
              </coding>
              <text value="Doctor Consultation"/>
          </code>
          
          <!--   The status is 'scheduled' so the doctor knows the patient is waiting.    --> 
          
  
          <performer>
              <!--   refer to the participant (the nurse) in this resource  -->
              <reference value="Practitioner/14"/>
              <display value="Doctor Dave"/>
          </performer>
        </simple>
    </activity>
</CarePlan>

JSON

Encounter to GP (Primary care Practitioner)

{
  "resourceType": "CarePlan",
  "text": {
    "status": "additional",
    "div": "<div>\n          <p>  Represents the flow of a patient within a practice. The plan is created when\n        they arrive and represents the 'care' of the patient over the course of that encounter.\n        They first see the nurse for basic observations (BP, pulse, temp) then the doctor for\n        the consultation and finally the nurse again for a tetanus immunization. As the plan is\n        updated (e.g. a new activity added), different versions of the plan exist, and workflow timings\n        for reporting can be gained by examining the plan history. This example is the version after\n        seeing the doctor, and waiting for the nurse.The plan can either be created 'ad hoc' and modified as\n        the parient progresses, or start with a standard template (which can, of course, be altered to suit the patient.</p>\n        </div>"
  },
  "contained": [
    {
      "resourceType": "Condition",
      "id": "p1",
      "subject": {
        "reference": "Patient/100",
        "display": "Peter James Chalmers"
      },
      "code": {
        "text": "Overseas encounter"
      },
      "status": "confirmed"
    }
  ],
  "patient": {
    "reference": "Patient/100",
    "display": "Peter James Chalmers"
  },
  "status": "active",
  "period": {
    "start": "2013-01-01T10:30:00-00:00"
  },
  "concern": [
    {
      "reference": "#p1",
      "display": "obesity"
    }
  ],
  "participant": [
    {
      "id": "part1",
      "role": {
        "coding": [
          {
            "system": "local",
            "code": "nur"
          }
        ],
        "text": "nurse"
      },
      "member": {
        "reference": "Practitioner/13",
        "display": "Nurse Nancy"
      }
    },
    {
      "id": "part2",
      "role": {
        "coding": [
          {
            "system": "local",
            "code": "doc"
          }
        ],
        "text": "doctor"
      },
      "member": {
        "reference": "Practitioner/14",
        "display": "Doctor Dave"
      }
    }
  ],
  "goal": [
    {
      "description": "Complete consultation"
    }
  ],
  "activity": [
    {
      "status": "completed",
      "prohibited": false,
      "actionResulting": [
        {
          "reference": "Encounter/example"
        }
      ],
      "simple": {
        "category": "encounter",
        "code": {
          "coding": [
            {
              "system": "local",
              "code": "nursecon"
            }
          ],
          "text": "Nurse Consultation"
        },
        "timingPeriod": {
          "start": "2013-01-01T10:38:00-00:00",
          "end": "2013-01-01T10:50:00-00:00"
        },
        "performer": [
          {
            "reference": "Practitioner/13",
            "display": "Nurse Nancy"
          }
        ]
      }
    },
    {
      "status": "scheduled",
      "prohibited": false,
      "simple": {
        "category": "encounter",
        "code": {
          "coding": [
            {
              "system": "local",
              "code": "doccon"
            }
          ],
          "text": "Doctor Consultation"
        },
        "performer": [
          {
            "reference": "Practitioner/14",
            "display": "Doctor Dave"
          }
        ]
      }
    }
  ]
}

comments powered by Disqus