1. FHIR DSTU 2 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. CarePlan

Get a list of care plans

get

/CarePlan

Retrieves a list of care plans that meet supplied query parameters.

Note:

  • The CarePlan.activity element is not supported and not returned. As a result, the CarePlan.activity.detail.status and CarePlan.activity.detail.prohibited modifier elements are not returned.
  • The description of the care plan is included in the CarePlan.text.div element as ASCII text.
  • In DSTU2, CareTeam is not a standalone resource. A care team is a care plan with participants. A care team is returned only if a care team-specific category code is supplied.
  • CareTeam.participant may have a reference to a contained RelatedPerson resource.

Authorization Types

This operation supports the following authorization types:

  • Provider
  • Patient
  • System

Request

Query Parameters
  • The number of results per page.
    Example: _count=50
  • The logical resource ID associated with the resource.
    • This parameter is required if the category parameter is not used.
    • May not be provided with the category, context, date, patient, or subject parameters.
    • When provided, _count is ignored.
    Example: _id=12345
  • The scope of the care plan being searched for.
    • This parameter is required if the _id parameter is not used.
    • Only supports the careteam, assess-plan, longitudinal, and encounter codes.
    • The careteam and assess-plan codes belong to the Argonaut system. longitudinal and encounter are defined by the CareTeam category system.
    Examples: category=assess-plan, category=http://argonaut.hl7.org|careteam, category=http://hl7.org/fhir/care-team-category|longitudinal, or category=careteam
  • The encounter ID of the care plan.
    • This parameter is required if the category parameter is present and set to encounter.
    • Cannot be set if the category parameter is set to careteam, assess-plan, or longitudinal.
    Example: context=1138
  • The time period that the plan covers.
    • May be provided up to two times, and must use the ge or le prefixes.
    • When provided twice, the lower value must have the ge prefix and the higher value must have the le prefix.
    • Will be ignored if category is set to encounter.
    Example: date=ge2016-08 or date=le2017-01-24T12:00:00.000Z
  • Who the care plan is for.
    • This parameter is required if the category parameter is present and set to careteam, assess-plan, or longitudinal, and the subject parameter is not used.
    • Cannot be provided with the subject parameter.
    Example: patient=12345
  • Who care plan is for.
    • Must represent a Patient resource.
    • May use the :Patient modifier.
    • This parameter is required if the category parameter is present and set to careteam, assess-plan, or longitudinal, and the patient parameter is not used.
    • Cannot be provided with the patient parameter.
    Example: subject=Patient/12345 or subject:Patient=12345
Header Parameters
Back to Top

Response

Supported Media Types

Default Response

Example search for a care plan.
Example Request: 
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan?patient=12724066&category=assess-plan
Example Response: 
{
    'resourceType': 'Bundle',
    'id': '7ea66921-b1a3-4719-9e06-83b8ffd91e02',
    'type': 'searchset',
    'link': [
      {
        'relation': 'self',
        'url': 'https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan'\
              '?patient=12724066&category=assess-plan&_count=10'
      }
    ],
    'entry': [
      {
        'fullUrl': 'https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan/197286315',
        'resource': DSTU2_CARE_PLAN_ENTRY
      }
    ]
  }
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

x-search-for-care-team Response

Example search for a care team.
Example Request: 
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan?patient=12724066&category=careteam
Example Response: 
{
    'resourceType': 'Bundle',
    'id': '3f0248ed-05e3-4194-889e-f843a9a0d9a0',
    'type': 'searchset',
    'total': 1,
    'link': [
      {
        'relation': 'self',
        'url': 'https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan'\
              '?patient=12724066&category=careteam'
      }
    ],
    'entry': [
      {
        'fullUrl': 'https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan/L12724066',
        'resource': {
          'resourceType': 'CarePlan',
          'id': 'L12724066',
          'meta': {
            'versionId': '12724066',
            'lastUpdated': '2019-12-26T15:41:55Z'
          },
          'text': {
            'status': 'generated',
            'div': '<div><p><b>Care Team</b></p><p><b>Patient</b>: SMART, NANCY</p><p><b>Status</b>: '\
                  'Active</p><p><b>Category</b>: CareTeam</p><p><b>Participants</b>:</p><p><b>Name</b>: '\
                  'Cerner Test, Physician - Hospitalist Cerner</p><p><b>Role</b>: Primary Care Physician'\
                  '</p></div>'
          },
          'subject': {
            'reference': 'Patient/12724066',
            'display': 'SMART, NANCY'
          },
          'status': 'active',
          'modified': '2019-12-26T15:41:55Z',
          'category': [
            {
              'coding': [
                {
                  'system': 'http://argonaut.hl7.org',
                  'code': 'careteam',
                  'display': 'CareTeam'
                }
              ]
            }
          ],
          'participant': [
            {
              'member': {
                'reference': 'Practitioner/4122622',
                'display': 'Cerner Test, Physician - Hospitalist Cerner'
              },
              'role': {
                'text': 'Primary Care Physician'
              }
            }
          ]
        }
      }
    ]
  }
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.
Back to Top