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.
Authorization Types
This operation supports the following authorization types:
Request
Query Parameters
-
_count: string
The number of results per page.
-
_id(required): string
The logical resource ID associated with the resource.
- This parameter is required if the
patientandcategoryparameters are not used. - May not be provided with any other parameters except for
_revincludeas indicated below. - When provided,
_countis ignored.
_id=12345 - This parameter is required if the
-
_revinclude: string
The Provenance resource entries to be returned as part of the bundle.
- May be provided once with the
Provenance:targetvalue. Example:_revinclude=Provenance:target - May be provided with the
_idorpatientparameter. Example:_id=178866310&_revinclude=Provenance:target - When
_revincludeis provided in a request to the closed endpoint, the OAuth2 token must include the scope corresponding with the authorization type, such asuser/Provenance.read,patient/Provenance.read, orsystem/Provenance.read.
_revinclude=Provenance:target - May be provided once with the
-
category(required): string
The scope of the care plan being searched for.
- This parameter is required if the
_idparameter is not used. - Only supports the
assess-plancode. - Can be combined with the
patientparameter.
category=assess-plan - This parameter is required if the
-
date: string
The time period that the plan covers.
- When provided, must use both
geandleprefixes in the same search. - The lower value must have the
geprefix and the higher value must have theleprefix. - The date precision must be consistent.
- May be combined with the patient and category parameters.
date=ge2016&date=le2017 (Jan 1, 2016 - Dec 31, 2017)ordate=ge2016-08-24T12:00:00.000Z&date=le2017-01-24T12:00:00.000Z - When provided, must use both
-
patient(required): string
Who the care plan is for. This parameter is required if the
_idparameter is not used.
Example:patient=12345
Header Parameters
-
Authorization(required): string
Contains the credentials to authenticate a consumer to the service. The credentials should be the OAuth2 Bearer Token.
-
accept(required): string
The media type to be requested. See what the resource's operation produces for what is supported.
Response
Supported Media Types
- application/json+fhir
Default Response
Example search.
Example Request:
Example Request:
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan?patient=12742400&category=assess-plan{
'resourceType': 'Bundle',
'id': '8c34294c-ba46-492d-bb8e-9937db0ddd5b',
'type': 'searchset',
'link': [
{
'relation': 'self',
'url': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan?patient=1316020&category=assess-plan'
},
{
'relation': 'next',
'url': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan?patient=1316020&category=assess-plan&-pageContext=eNqdU21r2zAQ_isrGfvkiJNfE0Mhjq0OQ2cbWwnbvhgjq5nAloLslHX0x09OM9Y2dKwBgXS6e-7R6e5hqkeMa8k16od7hlgnpGBNx--5HFHTN7-URPtmJ-QORUeraHY8VnLkP8fZ6or9E98qduinA9Ni5Fo0qOSjFsa5fiBTRMXH-OS6Ws0OWoZPycJetCHXPdpzPSgZtlO-HRJ7ZE4nPsnHEDvYBxsMFi8DmAM2iwKEx4UA4Ltx2SZiDv7cDih4oeOGLkYL_-jCcE7LlOZIq47vtboTHX-TnF7fWmlyjU0Keeg6s62jKo3riNIyXW8oqcwVubkhMU23pE4iSszFXdMN_II9ansxDELJD5ka-bz48TAIJho5cXwp6Lf6Nq3oy2qYak3f3ny_cfPQgU-z1Tsx9vL9GMe7AONegMEX1ONN_2u6lGd1UebbNCHl6299YYz6MLXEzH9CqphkSZp9_n8xnFR1LoXcTHszmhZ_fJLaecQkvr_8GflK63hTVvn0XHthgweB5S0wmIm3sLN0F7br2EYGYMGzUSpKsk3zTXWOxYHrO663tLDrBb6zBGz_AZv6HmeP8BuKWGNn&-pageDirection=NEXT'
}
],
'entry': [
{
'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan/17463459',
'resource': R4_CARE_PLAN_ENTRY
},
{
'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan/13435120',
'resource': {
'resourceType': 'CarePlan',
'id': '13435120',
'meta': {
'versionId': '1',
'lastUpdated': '2015-10-23T10:28:03.000-05:00'
},
'text': {
'status': 'additional',
'div': '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Care Plan</b></p><p><b>Patient</b>: Houde, Harry Potter</p><p><b>Title</b>: Admission H & P</p><p><b>Status</b>: Active</p><p><b>Intent</b>: Plan</p><p><b>Category</b>: Assessment and Plan of Treatment</p><p><b>Author</b>: Koester, Oliver</p><p><b>Effective Period</b>: Oct 23, 2015 3:25 P.M. UTC</p></div>'
},
'status': 'active',
'intent': 'plan',
'category': [
{
'coding': [
{
'system': 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category',
'code': 'assess-plan',
'display': 'Assessment and Plan of Treatment'
}
],
'text': 'Assessment and Plan of Treatment'
}
],
'title': 'Admission H & P',
'subject': {
'reference': 'Patient/1316020',
'display': 'Houde, Harry Potter'
},
'encounter': {
'reference': 'Encounter/1693915'
},
'period': {
'start': '2015-10-23T10:25:00.000-05:00'
},
'author': {
'reference': 'Practitioner/1830030',
'display': 'Koester, Oliver'
}
}
}
]
}
```
Headers
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id, if present. -
opc-request-id: string
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-with-_revinclude Response
Example search for a care plan while using the
Example Request:
_revinclude parameter.Example Request:
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan?_id=178866310&_revinclude=Provenance:target{
'resourceType': 'Bundle',
'id': '627a14f6-0eda-42ab-ad21-e860f5780a20',
'type': 'searchset',
'link': [
{
'relation': 'self',
'url': 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan?_id=178866310&_revinclude=Provenance%3Atarget'
}
],
'entry': [
{
'fullUrl': 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan/178866310',
'resource': {
'resourceType': 'CarePlan',
'id': '178866310',
'meta': {
'versionId': '1',
'lastUpdated': '2020-02-03T19:37:47.000Z'
},
'text': {
'status': 'additional',
'div': '<div xmlns=\'http://www.w3.org/1999/xhtml\'><p><b>Care Plan</b></p><p><b>Patient
</b>: SMITH, MORGAN</p><p><b>Description</b>: unknown</p><p><b>Status</b>: Active</p><p>
<b>Intent</b>: Plan</p><p><b>Category</b>: Assessment and Plan of Treatment</p>
<p><b>Effective Period</b>: Feb 3, 2020 7:39 P.M. UTC</p></div>'
},
'status': 'active',
'intent': 'plan',
'category': [
{
'coding': [
{
'system': 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category',
'code': 'assess-plan',
'display': 'Assessment and Plan of Treatment'
}
],
'text': 'Assessment and Plan of Treatment'
}
],
'subject': {
'reference': 'Patient/725944',
'display': 'SMITH, MORGAN'
},
'encounter': {
'reference': 'Encounter/953887'
},
'period': {
'start': '2020-02-03T19:39:33.000Z'
}
},
'search': {
'mode': 'match'
}
},
{
'fullUrl': 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/INT.doc-178866310',
'resource': {
'resourceType': 'Provenance',
'id': 'INT.doc-178866310',
'meta': {
'versionId': '178866310',
'lastUpdated': '2020-02-03T19:39:31Z'
},
'text': {
'status': 'generated',
'div': '<div xmlns=\'http://www.w3.org/1999/xhtml\'><p><b>Provenance</b></p>
<p><b>Target</b>:</p><ul><li>CarePlan/178866310</li></ul><p>
<b>Recorded</b>: Feb 3, 2020 1:39 P.M. CST</p>
<p><b>Agents</b>:</p><dl><dt>DEVENG-DEFAULT-PROV</dt><dd>
<b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd></dl></div>'
},
'target': [
{
'reference': 'CarePlan/178866310'
}
],
'recorded': '2020-02-03T19:39:31Z',
'agent': [
{
'type': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/provenance-participant-type',
'code': 'author'
}
],
'text': 'Author'
},
'role': [
{
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/contractsignertypecodes',
'code': 'SOURCE'
}
],
'text': 'Source'
}
],
'who': {
'reference': 'Organization/57535538',
'display': 'DEVENG-DEFAULT-PROV'
}
}
]
},
'search': {
'mode': 'include'
}
}
]
}Headers
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id, if present. -
opc-request-id: string
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-with-patient-auth Response
Example search for a care plan using patient authorization.
Example Request:
Example Request:
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan?patient=12724066&category=assess-plan{
'resourceType': 'Bundle',
'id': '013ed260-cdd4-4ffc-947e-aeadb699d3d4',
'type': 'searchset',
'link': [
{
'relation': 'self',
'url': 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan?patient=12724066&category=assess-plan'
}
],
'entry': [
{
'fullUrl': 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan/197375407',
'resource': R4_CARE_PLAN_PATIENT_ENTRY
},
{
'fullUrl': 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CarePlan/197286315',
'resource': {
'resourceType': 'CarePlan',
'id': '197286315',
'meta': {
'versionId': '1',
'lastUpdated': '2020-04-05T04:00:46.000Z'
},
'text': {
'status': 'additional',
'div': '<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Care Plan</b></p><p><b>Patient</b>: SMART, NANCY</p><p><b>Title</b>: Pregnancy Summary Document</p><p><b>Description</b>: SMART, NANCY\nDOB: 08/11/1980\tAge: 39 Years\tMRN: 00000006930\n------------------------------------------------------\n\t\t\t\tSMART, NANCY DOB: 08/11/80\nPregnancy Summary (Date of Report: 04/04/20)\n\nG 1 P 0 (0,0,0,0)\nGestation: --\tLMP (from pt. history): --\nEDD: --\tEDD/EGA Method: Date of Conception\tEGA: --\n\n-------------------------------\n\t\t\t\tSMART, NANCY DOB: 08/11/80\nAntepartum Note\n\n\tNo antepartum notes have been documented\n\n-------------------------------------\n\t\t\t\tSMART, NANCY DOB: 08/11/80\nProblems (Active Problems Only)\nGestational diabetes mellitus, class A>1< (Related to Pregnant problem) (SNOMED CT: 124602011, Onset: 03/05/20)\n\tComment: Problem added by Discern Expert (SYSTEM, SYSTEM Cerner on 03/05/20)\n\nGestational hypertension (Related to Pregnant problem) (SNOMED CT: 495022012, Onset: 03/05/20)\n\tComment: Problem added by Discern Expert (SYSTEM, SYSTEM Cerner on 03/05/20)\n\nPregnant (SNOMED CT: 191073013, Onset: 06/12/19)\n\n-----------------\n\t\t\t\tSMART, NANCY DOB: 08/11/80\nRisk Factors and Genetic Screening\nRisk Factors (Current Pregnancy)\nRisk Factors: Diabetes, gestational, type A1, Gestational hypertension\nRisk Factors Comments: --\n\nEthnic Screening\n***** END OF REPORT *****</p><p><b>Status</b>: Active</p><p><b>Intent</b>: Plan</p><p><b>Category</b>: Assessment and Plan of Treatment</p><p><b>Author</b>: SYSTEM, SYSTEM Cerner</p><p><b>Effective Period</b>: Apr 5, 2020 4:00 A.M. UTC</p></div>'
},
'status': 'active',
'intent': 'plan',
'category': [
{
'coding': [
{
'system': 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category',
'code': 'assess-plan',
'display': 'Assessment and Plan of Treatment'
}
],
'text': 'Assessment and Plan of Treatment'
}
],
'title': 'Pregnancy Summary Document',
'subject': {
'reference': 'Patient/12724066',
'display': 'SMART, NANCY'
},
'period': {
'start': '2020-04-05T04:00:45.000Z'
},
'author': {
'reference': 'Practitioner/1',
'display': 'SYSTEM, SYSTEM Cerner'
}
}
}
]
}Headers
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id, if present.