0.1.0 - ci-build

EgdeVJ_IG - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: VJ CarePlan

Defining URL:http://fhir.onegde.no/StructureDefinition/egde-vj-care-plan
Version:0.1.0
Name:VJCarePlan
Title:VJ CarePlan
Status:Draft as of 2021-08-18T14:36:33+02:00
Definition:

Resource containing the CarePlan details

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://fhir.onegde.no/StructureDefinition/egde-vj-care-plan

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... vj-note-description 0..*stringNote description
URL: http://fhir.onegde.no/StructureDefinition/vj-note-description
... vj-next-follow-up 0..1dateTimeNext followup date
URL: http://fhir.onegde.no/StructureDefinition/vj-next-follow-up
... vj-followup-period 0..1integerFollow Up Period
URL: http://fhir.onegde.no/StructureDefinition/vj-followup-period
... vj-follow-up-period-unit 0..1stringFollow Up Period Unit
URL: http://fhir.onegde.no/StructureDefinition/vj-follow-up-period-unit
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this plan
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
... basedOn Σ0..*Reference(CarePlan)Fulfills CarePlan
... replaces Σ0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf Σ0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!Σ1..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... title Σ0..1stringHuman-friendly name for the care plan
... description Σ1..1stringSummary of nature of plan
... subject Σ1..1Reference(Patient | Group)Who the care plan is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period Σ0..1PeriodTime period plan covers
... created Σ0..1dateTimeDate record was first recorded
... author Σ0..1Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who is the designated responsible party
... contributor 0..*Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who provided the content of the care plan
... careTeam 0..*Reference(CareTeam)Who's involved in plan?
... addresses Σ0..*Reference(Condition)Health issues this plan addresses
... supportingInfo 0..*Reference(Resource)Information considered as part of plan
... goal 0..*Reference(Goal)Desired outcome of plan
... activity I0..*BackboneElementAction to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept 0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.


.... outcomeReference 0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress 0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail I0..1BackboneElementIn-line definition of activity
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.

..... instantiatesCanonical 0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri 0..*uriInstantiates external protocol or definition
..... code 0..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

..... reasonCode 0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.


..... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why activity is needed
..... goal 0..*Reference(Goal)Goals this activity relates to
..... status ?!1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.

..... statusReason 0..1CodeableConceptReason for current status
..... doNotPerform ?!0..1booleanIf true, activity is prohibiting action
..... scheduled[x] 0..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location 0..1Reference(Location)Where it should happen
..... performer 0..*Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)Who will be responsible?
..... product[x] 0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.

...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount 0..1SimpleQuantityHow to consume/day?
..... quantity 0..1SimpleQuantityHow much to administer/supply/consume
..... description 0..1stringExtra info describing activity to perform
... note 0..*AnnotationComments about the plan

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... vj-note-description 0..*stringNote description
URL: http://fhir.onegde.no/StructureDefinition/vj-note-description
... vj-next-follow-up 0..1dateTimeNext followup date
URL: http://fhir.onegde.no/StructureDefinition/vj-next-follow-up
... vj-followup-period 0..1integerFollow Up Period
URL: http://fhir.onegde.no/StructureDefinition/vj-followup-period
... vj-follow-up-period-unit 0..1stringFollow Up Period Unit
URL: http://fhir.onegde.no/StructureDefinition/vj-follow-up-period-unit
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this plan
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
... basedOn Σ0..*Reference(CarePlan)Fulfills CarePlan
... replaces Σ0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf Σ0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!Σ1..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... title Σ0..1stringHuman-friendly name for the care plan
... description Σ1..1stringSummary of nature of plan
... subject Σ1..1Reference(Patient | Group)Who the care plan is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period Σ0..1PeriodTime period plan covers
... created Σ0..1dateTimeDate record was first recorded
... author Σ0..1Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who is the designated responsible party
... contributor 0..*Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who provided the content of the care plan
... careTeam 0..*Reference(CareTeam)Who's involved in plan?
... addresses Σ0..*Reference(Condition)Health issues this plan addresses
... supportingInfo 0..*Reference(Resource)Information considered as part of plan
... goal 0..*Reference(Goal)Desired outcome of plan
... activity I0..*BackboneElementAction to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept 0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.


.... outcomeReference 0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress 0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail I0..1BackboneElementIn-line definition of activity
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.

..... instantiatesCanonical 0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri 0..*uriInstantiates external protocol or definition
..... code 0..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

..... reasonCode 0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.


..... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why activity is needed
..... goal 0..*Reference(Goal)Goals this activity relates to
..... status ?!1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.

..... statusReason 0..1CodeableConceptReason for current status
..... doNotPerform ?!0..1booleanIf true, activity is prohibiting action
..... scheduled[x] 0..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location 0..1Reference(Location)Where it should happen
..... performer 0..*Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)Who will be responsible?
..... product[x] 0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.

...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount 0..1SimpleQuantityHow to consume/day?
..... quantity 0..1SimpleQuantityHow much to administer/supply/consume
..... description 0..1stringExtra info describing activity to perform
... note 0..*AnnotationComments about the plan

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
CarePlan.languagepreferredCommonLanguages
Max Binding: AllLanguages
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes

Constraints

IdPathDetailsRequirements
dom-2CarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3CarePlanIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4CarePlanIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5CarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6CarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1CarePlan.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CarePlan.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CarePlan.extension:noteDescriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CarePlan.extension:noteDescriptionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CarePlan.extension:nextFollowUpAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CarePlan.extension:nextFollowUpMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CarePlan.extension:followUpPeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CarePlan.extension:followUpPeriodMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CarePlan.extension:followUpPeriodUnitAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CarePlan.extension:followUpPeriodUnitMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CarePlan.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CarePlan.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CarePlan.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.instantiatesCanonicalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.replacesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.intentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.createdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.contributorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.careTeamAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.addressesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.supportingInfoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.goalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
cpl-3CarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
ele-1CarePlan.activityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CarePlan.activity.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CarePlan.activity.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CarePlan.activity.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CarePlan.activity.outcomeCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.outcomeReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.progressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CarePlan.activity.detail.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CarePlan.activity.detail.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CarePlan.activity.detail.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CarePlan.activity.detail.kindAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.instantiatesCanonicalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.instantiatesUriAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.goalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.statusReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.doNotPerformAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.scheduled[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.product[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.dailyAmountAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.quantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.activity.detail.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CarePlan.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())