CarePlanSe

Introduction

The CarePlanSe profile is used to retrieve data about care plans in COSMIC. The profile is based on the FHIR resource CarePlan.

Intended Use

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

Specific Rules and Limitations

Type Description
Rule The consumer of the API is responsible for making sure data retrieved is filtered in compliance with laws and regulations prior to presenting it to any end-users.
Rule For reading careplans, the external system needs to be able to evaluate PDL. This means whether the information can be displayed for a healthcare professional with a specific assignment. PDL data needed (HSA care unit and HSA care provider) is retrieved by including the organization referenced from Careplan.author.PractitionerRoleLiteSe(PractitionerRole.organization.OrganizationSEVendorLite).
Limitation This API can be used to find active care plans. Care plans that are completed or entered in error will not be returned.

Profile Overview

CarePlanSe

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..0Identifier
instantiatesCanonicalΣ0..0canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)
instantiatesUriΣ0..0uri
basedOnΣ I0..0Reference(CarePlan)
replacesΣ I0..0Reference(CarePlan)
partOfΣ I0..0Reference(CarePlan)
statusΣ ?!1..1codeBinding
intentΣ ?!1..1codeBindingFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
titleΣ0..1string
descriptionΣ0..0string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBinding
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
encounterΣ I0..1Reference(Encounter)
periodΣ I0..0Period
createdΣ0..1dateTime
authorΣ I0..1Reference(PractitionerRoleLiteSe)
contributorI0..0Reference(Practitioner | PractitionerRole | Device | RelatedPerson | Organization | PractitionerRoleLiteSe)
careTeamI0..0Reference(CareTeam)
addressesΣ I0..*Reference(Condition)
supportingInfoI0..0Reference(Resource)
goalI0..*Reference(Goal)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
outcomeCodeableConcept0..0CodeableConcept
outcomeReferenceI0..*Reference(Procedure)
progress0..0Annotation
referenceI0..0Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)
note0..0Annotation

Versions

COS version Profile version Required COSMIC version Date Description
3.9.0 1.0.0 3.9.0 September 2023 Initial version, Support for GET and search.

ValueSet

The profile includes bindings to the following Cambio defined value set: CarePlanCategory

Code Display
IP Individuell plan
SVP Standardiserad vårdplan

Supported Operations

HTTP Methods

Method Description
GET Used to retrieve a care plan.

Query Operations

Search Parameters

Parameter Format Comment
subject string The subject that the care plan is about.
_profile string Canonical url for specific profile (https://fhir.cambio.se/StructureDefinition/CarePlanSe)

Supported Queries

  1. GET [baseURL]/CarePlanSe

Error Codes

Code Description Comment
400 Invalid payloads