FHIR Data Standards Wales for PSOM v1.0.0-rc4
Important: This is the release candidate of the FHIR Data Standards Wales for PSOM version 1.0.0-rc4 Implementation Guide. It is intended for trial use, and is published for early comment and feedback. Click here to give feedback.

DataStandardsWales-PSOM-CarePlan

ProfileDescriptionStatusPurposeURL
Data Standards Wales PSOM CarePlan

The clinical circumstance for PROMs collection. The CarePlan is used to group Collection Events and provide context to the pathway.

active

The CarePlan functions as linking pin of all DSCN metadata relevant for a clinical circumstance.

https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-PSOM-CarePlan

Formal Views of Profile Content

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
pathwayLateralityC1..1Extension(CodeableConcept)
modifierExtension?! C0..*Extension
referralIdentifierΣ0..*DataStandardsWalesPSOMReferralIdentifier
instantiatesCanonicalΣ0..*canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)
instantiatesUriΣ0..*uri
basedOnΣ C0..*Reference(CarePlan)
replacesΣ C0..*Reference(CarePlan)
partOfΣ C0..*Reference(CarePlan)
statusΣ ?!1..1codeBinding
intentΣ ?!1..1codeBinding
treatmentSpecialtyΣ1..1CodeableConceptBinding
id0..1string
extensionC0..*Extension
codingΣ0..*Coding
textΣ0..1string
titleΣ0..1string
descriptionΣ0..1string
subjectΣ C1..1Reference(DataStandardsWalesPatient)
encounterΣ C0..1Reference(Encounter)
periodΣ C0..1Period
createdΣ0..1dateTime
authorΣ C1..1Reference(DataStandardsWalesPractitionerRole)
contributorC0..*Reference(CareTeam | Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
careTeamC0..*Reference(CareTeam)
addressesΣ C0..*Reference(Condition)
supportingInfoC0..*Reference(Resource)
goalC0..*Reference(Goal)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
outcomeCodeableConcept0..*CodeableConcept
outcomeReferenceC0..*Reference(Resource | UKCoreProcedure | DataStandardsWalesEncounter)
progress0..*Annotation
referenceC0..1Reference(CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | RequestGroup | Task | VisionPrescription | DataStandardsWalesAppointment | DataStandardsWalesServiceRequest)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
kind0..1codeBinding
instantiatesCanonical0..*canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)
instantiatesUri0..*uri
code0..1CodeableConcept
reasonCode0..*CodeableConcept
reasonReferenceC0..*Reference(Condition | DiagnosticReport | DocumentReference | Observation)
goalC0..*Reference(Goal)
status?!1..1codeBinding
statusReason0..1CodeableConcept
doNotPerform?!0..1boolean
scheduledPeriodPeriod
scheduledStringstring
scheduledTimingTiming
locationC0..1Reference(Location)
performerC0..*Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
productCodeableConceptCodeableConcept
productReferenceReference(Medication | Substance)
dailyAmountC0..1SimpleQuantity
quantityC0..1SimpleQuantity
description0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
outcomeCodeableConcept0..0CodeableConcept
outcomeReferenceC0..0Reference(Resource) | Reference(Resource | UKCoreProcedure | DataStandardsWalesEncounter)
progress0..0Annotation
referenceC1..1Reference(DataStandardsWalesPSOMTask) | Reference(CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | RequestGroup | Task | VisionPrescription | DataStandardsWalesAppointment | DataStandardsWalesServiceRequest)
note0..*Annotation
idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
pathwayLateralityC1..1Extension(CodeableConcept)
modifierExtension?! C0..*Extension
referralIdentifierΣ0..*DataStandardsWalesPSOMReferralIdentifier
instantiatesCanonicalΣ0..*canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)
instantiatesUriΣ0..*uri
basedOnΣ C0..*Reference(CarePlan)
replacesΣ C0..*Reference(CarePlan)
partOfΣ C0..*Reference(CarePlan)
statusΣ ?!1..1codeBinding
intentΣ ?!1..1codeBinding
treatmentSpecialtyΣ1..1CodeableConceptBinding
id0..1string
extensionC0..*Extension
codingΣ0..*Coding
textΣ0..1string
titleΣ0..1string
descriptionΣ0..1string
subjectΣ C1..1Reference(DataStandardsWalesPatient)
encounterΣ C0..1Reference(Encounter)
periodΣ C0..1Period
createdΣ0..1dateTime
authorΣ C1..1Reference(DataStandardsWalesPractitionerRole)
contributorC0..*Reference(CareTeam | Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
careTeamC0..*Reference(CareTeam)
addressesΣ C0..*Reference(Condition)
supportingInfoC0..*Reference(Resource)
goalC0..*Reference(Goal)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
outcomeCodeableConcept0..*CodeableConcept
outcomeReferenceC0..*Reference(Resource | UKCoreProcedure | DataStandardsWalesEncounter)
progress0..*Annotation
referenceC0..1Reference(CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | RequestGroup | Task | VisionPrescription | DataStandardsWalesAppointment | DataStandardsWalesServiceRequest)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
kind0..1codeBinding
instantiatesCanonical0..*canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)
instantiatesUri0..*uri
code0..1CodeableConcept
reasonCode0..*CodeableConcept
reasonReferenceC0..*Reference(Condition | DiagnosticReport | DocumentReference | Observation)
goalC0..*Reference(Goal)
status?!1..1codeBinding
statusReason0..1CodeableConcept
doNotPerform?!0..1boolean
scheduledPeriodPeriod
scheduledStringstring
scheduledTimingTiming
locationC0..1Reference(Location)
performerC0..*Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
productCodeableConceptCodeableConcept
productReferenceReference(Medication | Substance)
dailyAmountC0..1SimpleQuantity
quantityC0..1SimpleQuantity
description0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
outcomeCodeableConcept0..0CodeableConcept
outcomeReferenceC0..0Reference(Resource) | Reference(Resource | UKCoreProcedure | DataStandardsWalesEncounter)
progress0..0Annotation
referenceC1..1Reference(DataStandardsWalesPSOMTask) | Reference(CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | RequestGroup | Task | VisionPrescription | DataStandardsWalesAppointment | DataStandardsWalesServiceRequest)
note0..*Annotation
idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
pathwayLateralityC1..1Extension(CodeableConcept)
modifierExtension?! C0..*Extension
referralIdentifierΣ0..*DataStandardsWalesPSOMReferralIdentifier
instantiatesCanonicalΣ0..*canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)
instantiatesUriΣ0..*uri
basedOnΣ C0..*Reference(CarePlan)
replacesΣ C0..*Reference(CarePlan)
partOfΣ C0..*Reference(CarePlan)
statusΣ ?!1..1codeBinding
intentΣ ?!1..1codeBinding
treatmentSpecialtyΣ1..1CodeableConceptBinding
id0..1string
extensionC0..*Extension
codingΣ0..*Coding
textΣ0..1string
titleΣ0..1string
descriptionΣ0..1string
subjectΣ C1..1Reference(DataStandardsWalesPatient)
encounterΣ C0..1Reference(Encounter)
periodΣ C0..1Period
createdΣ0..1dateTime
authorΣ C1..1Reference(DataStandardsWalesPractitionerRole)
contributorC0..*Reference(CareTeam | Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
careTeamC0..*Reference(CareTeam)
addressesΣ C0..*Reference(Condition)
supportingInfoC0..*Reference(Resource)
goalC0..*Reference(Goal)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
outcomeCodeableConcept0..*CodeableConcept
outcomeReferenceC0..*Reference(Resource | UKCoreProcedure | DataStandardsWalesEncounter)
progress0..*Annotation
referenceC0..1Reference(CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | RequestGroup | Task | VisionPrescription | DataStandardsWalesAppointment | DataStandardsWalesServiceRequest)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
kind0..1codeBinding
instantiatesCanonical0..*canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)
instantiatesUri0..*uri
code0..1CodeableConcept
reasonCode0..*CodeableConcept
reasonReferenceC0..*Reference(Condition | DiagnosticReport | DocumentReference | Observation)
goalC0..*Reference(Goal)
status?!1..1codeBinding
statusReason0..1CodeableConcept
doNotPerform?!0..1boolean
scheduledPeriodPeriod
scheduledStringstring
scheduledTimingTiming
locationC0..1Reference(Location)
performerC0..*Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
productCodeableConceptCodeableConcept
productReferenceReference(Medication | Substance)
dailyAmountC0..1SimpleQuantity
quantityC0..1SimpleQuantity
description0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
outcomeCodeableConcept0..0CodeableConcept
outcomeReferenceC0..0Reference(Resource) | Reference(Resource | UKCoreProcedure | DataStandardsWalesEncounter)
progress0..0Annotation
referenceC1..1Reference(DataStandardsWalesPSOMTask) | Reference(CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | RequestGroup | Task | VisionPrescription | DataStandardsWalesAppointment | DataStandardsWalesServiceRequest)
note0..*Annotation
PathDSCNIDName
CarePlan.category:treatmentSpecialtyPROMs-Metadata-2024004MEDPX001XTreatment Specialty Code
CarePlan.category:pathwayTypePROMs-Metadata-2024004MPRPX005XPROMs Pathway Type
CarePlan.category:pathwayType.textPROMs-Metadata-2024004MPRPX009XLocal PROMs Pathway Type
CarePlan.subjectPROMs-Metadata-2024004MPDPX001XNHS Number (implicit, main mapping is on Patient.identifier:nhsNumber)
CarePlan.subjectPROMs-Metadata-2024004MPDPX001ANHS Number Status Indicator (implicit, main mapping is on Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus)
CarePlan.subjectPROMs-Metadata-2024004MPDPX002ALocal Person Identifier Origination (implicit, main mapping is on Patient.identifier:[HealthBoard]PasIdentifier.type)
CarePlan.subjectPROMs-Metadata-2024004MPDPX002XLocal Person Identifier (implicit, main mapping is on Patient.identifier:[HealthBoard]PasIdentifier.value)
CarePlan.subjectPROMs-Metadata-2024004MPDPX003XGiven Name (implicit, main mapping is on Patient.name.given)
CarePlan.subjectPROMs-Metadata-2024004MPDPX004XFamily Name (implicit, main mapping is on Patient.name.family)
CarePlan.subjectPROMs-Metadata-2024004MPDPX005XDate of Birth (implicit, main mapping is on Patient.birthDate)
CarePlan.subjectPROMs-Metadata-2024004MPDPX006XGender Identity (implicit, main mapping is on Patient.gender)
CarePlan.subjectPROMs-Metadata-2024004MPDPX007XPostcode (implicit, main mapping is on Patient.address.postalCode)
CarePlan.authorPROMs-Metadata-2024004MEDPX002ASenior Responsible Professional Name (implicit, main mapping is on Practitioner.name)
CarePlan.authorPROMs-Metadata-2024004MEDPX002BSenior Responsible Professional Identifier Code System (implicit, main mapping is on Practitioner.identifier.system)
CarePlan.authorPROMs-Metadata-2024004MEDPX002CSenior Responsible Professional Identifier (implicit, main mapping is on Practitioner.identifier.value)
CarePlan.authorPROMs-Metadata-2024004MDDPX002XOriginating Organisation Code (implicit, main mapping is on Organization.identifier)

Below is an overview of recommended Server RESTful FHIR search interactions for this profile. The search syntax used to describe the interactions is described here. The following search parameters are recommended:

  1. identifier
  2. category
  3. identifier-assigner *custom defined SearchParameter
  4. patient

Referral Identifier

Retrieves all CarePlan resources that have the specified Referral Identifier:

GET [base]/CarePlan?identifier=urn:oid:2.16.840.1.113883.2.1.8.1.5.140|12345678

Pathway Type

Retrieves all CarePlan resources that have the specified pathway type:

GET [base]/CarePlan?category=https://fhir.nhs.wales/CodeSystem/DataStandardsWales-PSOM-PathwayType|HIA

Treatment Specialty

Retrieves all CarePlan resources that have the specified treatment specialty:

GET [base]/CarePlan?category=http://snomed.info/sct|394593009

Originating Organisation

Retrieves all CarePlan resources that have the specified originating organisation:

GET [base]/CarePlan?identifier-assigner:Organization.identifier=https://fhir.nhs.uk/Id/ods-organization-code|7A4

Patient

Retrieves all CarePlan resources that belong to the specified patient:

GET [base]/CarePlan?patient.identifier=https://fhir.cavuhb.nhs.wales/Id/pas-identifier|A000003