Usage scenarios

The following are supported usage scenarios for this profile:

• Query for a care plan for a patient
• Record or update a patient’s care plans

Comparison with other national and international specifications

A resource conforming to this profile:

• MAY be conformant to US Core CarePlan if CarePlan.text is included and CarePlan.category supplies the US Core specific terminology

No equivalent International Patient Access or International Patient Summary profile, noting that International Patient Summary supports the core FHIR CarePlan resource unprofiled.

Conformance in reverse is not guaranteed, i.e. a resource conforming to US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

• a care plan can be
  • primarily narrative care plan supported using CarePlan.text
  • structured using CarePlan.goal and CarePlan.activity
• to tie a care plan to a specific condition, CarePlan.addresses can be used to reference a Condition resource.
• a Provenance resource can be used for detailed review information such as date of last review and who reviewed the care plan.

Specific feedback is sought on appropriate category values for care plans.

Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

1. SHALL support searching using the patient search parameter:
   • SHALL support these _revinclude parameters: Provenance:target
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

   GET [base]/CarePlan?patient={Type/}[id] or optionally GET [base]/CarePlan?patient.identifier=[system|][code]

   Example:

   1. GET [base]/CarePlan?patient=5678
   2. GET [base]/CarePlan?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
   3. GET [base]/CarePlan?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

   Implementation Notes: Fetches a bundle of all CarePlan resources for the specified patient (how to search by reference and how to search by token)

2. SHALL support searching using the combination of the patient and category search parameters:
   • SHALL support these _revinclude parameters: Provenance:target
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

   GET [base]/CarePlan?patient={Type/}[id]&category={system|}[code]

   Example:

   1. GET [base]/CarePlan?patient=5678&category=http://snomed.info/sct|736248007
   2. GET [base]/CarePlan?patient=5678&category=http://snomed.info/sct|736248007&_revinclude=Provenance:target

   Implementation Notes: Fetches a bundle of all CarePlan resources for the specified patient and a category code = 736248007 (how to search by reference and how to search by token)

Optional Search Parameters

The following search parameters and search parameter combinations SHOULD be supported:

1. SHOULD support searching using the combination of the patient and category and date search parameters:
   • SHALL support these _revinclude parameters: Provenance:target
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
   • SHALL support these date comparators: gt,lt,ge,le
   • SHOULD support multipleAnd search on date (e.g.date=[date]&date=[date]]&...)

   GET [base]/CarePlan?patient={Type/}[id]&category={system|}[code]&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

   Example:

   1. GET [base]/CarePlan?patient=5678&category=http://snomed.info/sct|736248007&date=ge2020-01-01T00:00:00Z

   Implementation Notes: Fetches a bundle of all CarePlan resources for the specified patient and date and a category code = 736248007 (how to search by reference and how to search by token and how to search by date)

2. SHOULD support searching using the combination of the patient and category and status search parameters:
   • SHALL support these _revinclude parameters: Provenance:target
   • SHALL support multipleOr search on status (e.g.status={system|}[code],{system|}[code],...)

   GET [base]/CarePlan?patient={Type/}[id]&category={system|}[code]&status={system|}[code]{,{system|}[code],...}

   Example:

   1. GET [base]/CarePlan?patient=5678&category=http://snomed.info/sct|736248007&status=active

   Implementation Notes: Fetches a bundle of all CarePlan resources for the specified patient and category and status (how to search by reference and how to search by token)

3. SHOULD support searching using the combination of the patient and category and status and date search parameters:
   • SHALL support these _revinclude parameters: Provenance:target
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
   • SHALL support multipleOr search on status (e.g.status={system|}[code],{system|}[code],...)
   • SHALL support these date comparators: gt,lt,ge,le
   • SHOULD support multipleAnd search on date (e.g.date=[date]&date=[date]]&...)

   GET [base]/CarePlan?patient={Type/}[id]&category={system|}[code]&status={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

   Example:

   1. GET [base]/CarePlan?patient=5678&category=http://snomed.info/sct|736248007&status=active&date=ge2020-01-01T00:00:00Z

   Implementation Notes: Fetches a bundle of all CarePlan resources for the specified patient and category and status (how to search by reference and how to search by token) and how to search by date)