STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). 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

Careplan-example-pregnancy.xml

Raw XML (canonical form)

Patient 1 for linking (id = "preg")

<CarePlan xmlns="http://hl7.org/fhir">
  <id value="preg"/>
  <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 value="p1"/>
      <patient>
        <reference value="Patient/1"/>
        <display value="Eve Everywoman"/>
      </patient>
      <code>
        <text value="pregnancy"/>
      </code>
      <verificationStatus value="confirmed"/>
    </Condition>
  </contained>
  <contained>
    <Practitioner>
      <id value="pr1"/>
      <name>
        <family value="Midwife"/>
        <given value="Mavis"/>
      </name>
      <practitionerRole>
        <specialty>
          <text value="Midwife"/>
        </specialty>
      </practitionerRole>
    </Practitioner>
  </contained>
  <contained>
    <Practitioner>
      <id value="pr2"/>
      <name>
        <family value="Obstetrician"/>
        <given value="Oscar"/>
      </name>
      <practitionerRole>
        <specialty>
          <text value="Obstetrician"/>
        </specialty>
      </practitionerRole>
    </Practitioner>
  </contained>
  <contained>
    <Goal>
      <id value="goal"/>
      <subject>
        <reference value="Patient/1"/>
        <display value="Eve Everywoman"/>
      </subject>
      <description value="Maintain patient's health throughout pregnancy and ensure a healthy child"/>
      <status value="in-progress"/>
    </Goal>
  </contained>
  <!--   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>
  <subject>
    <reference value="Patient/1"/>
    <display value="Eve Everywoman"/>
  </subject>
  <status value="active"/>
  <period>
    <!--   The likely duration of the pregnancy   -->
    <start value="2013-01-01"/>
    <end value="2013-10-01"/>
  </period>
  <addresses>
    <reference value="#p1"/>
    <display value="pregnancy"/>
  </addresses>
  <participant>
    <!--   In New Zealand, there is a Lead Maternity Carer (LMC) - often a midwife   -->
    <role>
      <coding>
        <system value="http://example.org/mysys"/>
        <code value="lmc"/>
      </coding>
      <text value="Midwife"/>
    </role>
    <member>
      <!--   This links to the clinician 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="http://example.org/mysys"/>
        <code value="obs"/>
      </coding>
      <text value="Obstretitian"/>
    </role>
    <member>
      <!--   This links to the clinician resource, so we get all the stuff related to that like address,
       contact etc...   -->
      <reference value="#pr2"/>
      <display value="Oscar Obstetrician"/>
    </member>
  </participant>
  <goal>
    <reference value="#goal"/>
  </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>
    <detail>
      <category><coding><system value="http://hl7.org/fhir/care-plan-activity-category"/><code value="encounter"/></coding></category>
      <code>
        <coding>
          <system value="http://example.org/mySystem"/>
          <code value="1an"/>
        </coding>
        <text value="First Antenatal encounter"/>
      </code>
      <status value="scheduled"/>
      <prohibited value="false"/>
      <scheduledTiming>
        <!--   The encounter should occur between 14 feb and 28 feb   -->
        <repeat>
          <boundsPeriod>
            <start value="2013-02-14"/>
            <end value="2013-02-28"/>
          </boundsPeriod>
        </repeat>
      </scheduledTiming>
      <performer>
        <reference value="#pr1"/>
        <display value="Mavis Midwife"/>
      </performer>
      <description 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
        <actionTaken>
            <url value="xxx"/>
            <display value="Appointment with Mavis midwife @12.30pm, 112 St albans Ave"/>
        </actionTaken>  -->
    </detail>
  </activity>
  <activity>
    <detail>
      <!--   This will be the second antenatal encounter - 3 months after LMP. It is not yet scheduled.
         -->
      <category><coding><system value="http://hl7.org/fhir/care-plan-activity-category"/><code value="encounter"/></coding></category>
      <code>
        <!--   The code is just for an antenatal encounter. There are many of these, the first is special...
           -->
        <coding>
          <system value="http://example.org/mySystem"/>
          <code value="an"/>
        </coding>
        <text value="Follow-up Antenatal encounter"/>
      </code>
      <status value="not-started"/>
      <prohibited value="false"/>
      <scheduledTiming>
        <!--   The encounter should occur between 1 march and 14 march   -->
        <repeat>
          <boundsPeriod>
            <start value="2013-03-01"/>
            <end value="2013-03-14"/>
          </boundsPeriod>
        </repeat>
      </scheduledTiming>
      <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>
      <description value="The second antenatal encounter. Discuss any issues that arose from the first antenatal
       encounter"/>
    </detail>
  </activity>
  <!--   
        There would be a number of other encounters to be scheduled here... 
        ...
        ...
    
      -->
  <activity>
    <detail>
      <!--   This will be the delivery. It is not yet scheduled.   -->
      <category><coding><system value="http://hl7.org/fhir/care-plan-activity-category"/><code value="encounter"/></coding></category>
      <code>
        <coding>
          <system value="http://example.org/mySystem"/>
          <code value="del"/>
        </coding>
        <text value="Delivery"/>
      </code>
      <status value="not-started"/>
      <prohibited value="false"/>
      <scheduledTiming>
        <!--   The delivery should occur between 1 September and 14 September   -->
        <repeat>
          <boundsPeriod>
            <start value="2013-09-01"/>
            <end value="2013-09-14"/>
          </boundsPeriod>
        </repeat>
      </scheduledTiming>
      <!--   Where the delivery is to occur... 
          Commented out for now because location resource isn't defined
        <location>
            <url value="loc100"/>
            <display value="St Albans delivery suite"/>
        </location>  -->
      <performer>
        <!--   The intention is that Maris will be performing the delivery...   -->
        <reference value="#pr1"/>
        <display value="Mavis Midwife"/>
      </performer>
      <description value="The delivery."/>
    </detail>
  </activity>
</CarePlan>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.