IL Core Implementation Guide
0.18.0 - draft
IL Core Implementation Guide
0.18.0 - draft
This page is part of the IL-Core IG (v0.18.0: draft-1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.health.gov.il/StructureDefinition/il-core-care-plan | Version: 0.18.0 | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: ILCoreCarePlan | ||
Israel Core proposed constraints and extensions on the CarePlan Resource
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CarePlan
| Path | Conformance | ValueSet | URI |
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
  CarePlan |
0..* | CarePlan | ILCore CarePlan Profile | |||||
  id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this plan | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ILCore PlanDefinition Profile | ILCore Questionnaire Profile | ILCore Measure Profile | ILCore ActivityDefinition Profile | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
 basedOn |
Σ | 0..* | Reference(ILCore CarePlan Profile) | Fulfills CarePlan | ||||
| replaces |
Σ | 0..* | Reference(ILCore CarePlan Profile) | CarePlan replaced by this CarePlan | ||||
| partOf |
Σ | 0..* | Reference(ILCore CarePlan Profile) | Part of referenced CarePlan | ||||
| status |
?!Σ | 1..1 | code | draft | 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..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
| category |
Σ | 0..* | CodeableConcept | Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
| title |
Σ | 0..1 | string | Human-friendly name for the care plan | ||||
| description |
Σ | 0..1 | string | Summary of nature of plan | ||||
| subject |
Σ | 1..1 | Reference(ILCore Patient Profile | ILCore Group Profile) | Who the care plan is for | ||||
| encounter |
Σ | 0..1 | Reference(ILCore Encounter Profile) | Encounter created as part of | ||||
| period |
Σ | 0..1 | Period | Time period plan covers | ||||
| created |
Σ | 0..1 | dateTime | Date record was first recorded | ||||
| author |
Σ | 0..1 | Reference(ILCore Patient Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Device Profile | ILCore RelatedPerson Profile | ILCore Organization Profile | ILCore CareTeam Profile) | Who is the designated responsible party | ||||
| contributor |
0..* | Reference(ILCore Patient Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Device Profile | ILCore RelatedPerson Profile | ILCore Organization Profile | ILCore CareTeam Profile) | Who provided the content of the care plan | |||||
| careTeam |
0..* | Reference(ILCore CareTeam Profile) | Who's involved in plan? | |||||
| addresses |
Σ | 0..* | Reference(ILCore Condition Profile) | Health issues this plan addresses | ||||
| supportingInfo |
0..* | Reference(Resource) | Information considered as part of plan | |||||
| goal |
0..* | Reference(ILCore Goal Profile) | Desired outcome of plan | |||||
 activity |
C | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| outcomeCodeableConcept |
0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
| outcomeReference |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
| progress |
0..* | Annotation | Comments about the activity status/progress | |||||
| reference |
C | 0..1 | Reference(Appointment | ILCore CommunicationRequest Profile | ILCore DeviceRequest Profile | ILCore MedicationRequest Profile | ILCore Molecular Sequence | ILCore Task Profile | ILCore ServiceRequest Profile | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
 detail |
C | 0..1 | BackboneElement | In-line definition of activity | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| kind |
0..1 | code | Appointment | 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(ILCore PlanDefinition Profile | ILCore Questionnaire Profile | ILCore Measure Profile | ILCore ActivityDefinition Profile | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| code |
0..1 | CodeableConcept | Detail 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..* | CodeableConcept | Why 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(ILCore Condition Profile | ILCore Observation Profile | ILCore DiagnosticReport Profile | ILCore DocumentReference Profile) | Why activity is needed | |||||
| goal |
0..* | Reference(ILCore Goal Profile) | Goals this activity relates to | |||||
| status |
?! | 1..1 | code | not-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..1 | CodeableConcept | Reason for current status | |||||
| doNotPerform |
?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
 scheduled[x] |
0..1 | When activity is to occur | ||||||
| scheduledTiming |
Timing | |||||||
| scheduledPeriod |
Period | |||||||
 scheduledString |
string | |||||||
| location |
0..1 | Reference(ILCore Location Profile) | Where it should happen | |||||
| performer |
0..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | ILCore RelatedPerson Profile | ILCore Patient Profile | ILCore CareTeam Profile | ILCore HealthcareService Profile | ILCore Device Profile) | Who will be responsible? | |||||
 Slices for product[x] |
0..1 | What is to be administered/supplied Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
 productCodeableConcept |
CodeableConcept | |||||||
| productReference |
Reference(Medication | Substance) | |||||||
  product[x]:productReference |
0..1 | Reference(ILCore Medication Profile | ILCore Substance Profile) | What is to be administered/supplied | |||||
| dailyAmount |
0..1 | SimpleQuantity | How to consume/day? | |||||
| quantity |
0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
| description |
0..1 | string | Extra info describing activity to perform | |||||
| note |
0..* | Annotation | Comments about the plan | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| CarePlan.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1from the FHIR Standard | ||||
| CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryfrom the FHIR Standard | ||||
| CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcomefrom the FHIR Standard | ||||
| CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1from the FHIR Standard | ||||
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard |
This structure is derived from CarePlan
Summary
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Differential View
This structure is derived from CarePlan
Key Elements View
| Path | Conformance | ValueSet | URI |
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | ILCore CarePlan Profile | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this plan | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ILCore PlanDefinition Profile | ILCore Questionnaire Profile | ILCore Measure Profile | ILCore ActivityDefinition Profile | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(ILCore CarePlan Profile) | Fulfills CarePlan | ||||
| replaces |
Σ | 0..* | Reference(ILCore CarePlan Profile) | CarePlan replaced by this CarePlan | ||||
| partOf |
Σ | 0..* | Reference(ILCore CarePlan Profile) | Part of referenced CarePlan | ||||
| status |
?!Σ | 1..1 | code | draft | 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..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
| category |
Σ | 0..* | CodeableConcept | Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
| title |
Σ | 0..1 | string | Human-friendly name for the care plan | ||||
| description |
Σ | 0..1 | string | Summary of nature of plan | ||||
| subject |
Σ | 1..1 | Reference(ILCore Patient Profile | ILCore Group Profile) | Who the care plan is for | ||||
| encounter |
Σ | 0..1 | Reference(ILCore Encounter Profile) | Encounter created as part of | ||||
| period |
Σ | 0..1 | Period | Time period plan covers | ||||
| created |
Σ | 0..1 | dateTime | Date record was first recorded | ||||
| author |
Σ | 0..1 | Reference(ILCore Patient Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Device Profile | ILCore RelatedPerson Profile | ILCore Organization Profile | ILCore CareTeam Profile) | Who is the designated responsible party | ||||
| contributor |
0..* | Reference(ILCore Patient Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Device Profile | ILCore RelatedPerson Profile | ILCore Organization Profile | ILCore CareTeam Profile) | Who provided the content of the care plan | |||||
| careTeam |
0..* | Reference(ILCore CareTeam Profile) | Who's involved in plan? | |||||
| addresses |
Σ | 0..* | Reference(ILCore Condition Profile) | Health issues this plan addresses | ||||
| supportingInfo |
0..* | Reference(Resource) | Information considered as part of plan | |||||
| goal |
0..* | Reference(ILCore Goal Profile) | Desired outcome of plan | |||||
| activity |
C | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| outcomeCodeableConcept |
0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
| outcomeReference |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
| progress |
0..* | Annotation | Comments about the activity status/progress | |||||
| reference |
C | 0..1 | Reference(Appointment | ILCore CommunicationRequest Profile | ILCore DeviceRequest Profile | ILCore MedicationRequest Profile | ILCore Molecular Sequence | ILCore Task Profile | ILCore ServiceRequest Profile | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
| detail |
C | 0..1 | BackboneElement | In-line definition of activity | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| kind |
0..1 | code | Appointment | 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(ILCore PlanDefinition Profile | ILCore Questionnaire Profile | ILCore Measure Profile | ILCore ActivityDefinition Profile | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| code |
0..1 | CodeableConcept | Detail 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..* | CodeableConcept | Why 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(ILCore Condition Profile | ILCore Observation Profile | ILCore DiagnosticReport Profile | ILCore DocumentReference Profile) | Why activity is needed | |||||
| goal |
0..* | Reference(ILCore Goal Profile) | Goals this activity relates to | |||||
| status |
?! | 1..1 | code | not-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..1 | CodeableConcept | Reason for current status | |||||
| doNotPerform |
?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
| scheduled[x] |
0..1 | When activity is to occur | ||||||
| scheduledTiming |
Timing | |||||||
| scheduledPeriod |
Period | |||||||
| scheduledString |
string | |||||||
| location |
0..1 | Reference(ILCore Location Profile) | Where it should happen | |||||
| performer |
0..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | ILCore RelatedPerson Profile | ILCore Patient Profile | ILCore CareTeam Profile | ILCore HealthcareService Profile | ILCore Device Profile) | Who will be responsible? | |||||
| Slices for product[x] |
0..1 | What is to be administered/supplied Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
| productCodeableConcept |
CodeableConcept | |||||||
| productReference |
Reference(Medication | Substance) | |||||||
| product[x]:productReference |
0..1 | Reference(ILCore Medication Profile | ILCore Substance Profile) | What is to be administered/supplied | |||||
| dailyAmount |
0..1 | SimpleQuantity | How to consume/day? | |||||
| quantity |
0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
| description |
0..1 | string | Extra info describing activity to perform | |||||
| note |
0..* | Annotation | Comments about the plan | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| CarePlan.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1from the FHIR Standard | ||||
| CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryfrom the FHIR Standard | ||||
| CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcomefrom the FHIR Standard | ||||
| CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1from the FHIR Standard | ||||
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard |
This structure is derived from CarePlan
Summary
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
