FHIR Osiris Implementation Guide
2.1.0 - ci-build
FHIR Osiris Implementation Guide
2.1.0 - ci-build
FHIR Osiris Implementation Guide - Local Development build (v2.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment | Version: 2.1.0 | |||
| Draft as of 2024-03-21 | Computable Name: Treatment | |||
Description of a treatment plan related to an Oncology Patient.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
  treatment-line | S | 0..1 | integer | Line number the treatment URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment-line |
  value[x]:valueInteger | 0..1 | integer | Line number the treatment | |
  category | S | 1..1 | CodeableConcept | Type of treatment Binding: Treatment Type Value Set (required) |
 subject | S | 1..1 | Reference(Oncology Patient) | Who the care plan is for |
| period | ||||
| start | S | 1..1 | dateTime | Start date |
 end | S | 1..1 | dateTime | End date |
| supportingInfo | 0..1 | Reference(Oncology Clinical Trial) | Objective of the treatment | |
  Slices for activity | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by pattern:detail.code.coding.system | |
  activity:All Slices | Content/Rules for all slices | |||
  detail | ||||
| code | 0..1 | CodeableConcept | Detail type of activity | |
| reasonReference | S | 0..* | Reference(Tumor Pathology Event) | Why activity is needed |
| activity:activity-code | 0..1 | BackboneElement | Classification Commune des Actes Médicaux (CCAM) code of the medical act | |
 detail | 1..1 | BackboneElement | In-line definition of activity | |
| code | 1..1 | CodeableConcept | CCAM code of the medical act | |
| coding | ||||
| system | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.atih.sante.fr/les-versions-de-la-ccam | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.category | required | TreatmentTypehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/TreatmentTypefrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| treatment-line | S | 0..1 | integer | Line number the treatment URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment-line |
  extension | 0..0 | |||
| url | 1..1 | uri | "https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment-line" | |
| Slices for value[x] | 0..1 | integer | Value of extension Slice: Unordered, Closed by type:$this | |
 value[x]:valueInteger | S | 0..1 | integer | Line number the treatment |
 modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| 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 | SΣ | 1..1 | CodeableConcept | Type of treatment Binding: Treatment Type Value Set (required) |
| subject | SΣC | 1..1 | Reference(Oncology Patient) | Who the care plan is for ref-1: SHALL have a contained resource if a local reference is provided |
| period | ΣC | 0..1 | Period | Time period plan covers per-1: If present, start SHALL have a lower value than end |
| start | SΣC | 1..1 | dateTime | Start date |
| end | SΣC | 1..1 | dateTime | End date |
| supportingInfo | C | 0..1 | Reference(Oncology Clinical Trial) | Objective of the treatment ref-1: SHALL have a contained resource if a local reference is provided |
| Slices for activity | C | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by pattern:detail.code.coding.system cpl-3: Provide a reference or detail, not both |
| activity:All Slices | Content/Rules for all slices | |||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource ref-1: SHALL have a contained resource if a local reference is provided |
| detail | C | 0..1 | BackboneElement | In-line definition of activity |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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. | |
| reasonReference | SC | 0..* | Reference(Tumor Pathology Event) | Why activity is needed ref-1: SHALL have a contained resource if a local reference is provided |
| 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. |
| doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action |
| activity:activity-code | C | 0..1 | BackboneElement | Classification Commune des Actes Médicaux (CCAM) code of the medical act cpl-3: Provide a reference or detail, not both |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource ref-1: SHALL have a contained resource if a local reference is provided |
| detail | C | 1..1 | BackboneElement | In-line definition of activity |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | 1..1 | CodeableConcept | CCAM code of the medical act Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |
| 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. |
| doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action |
| Documentation for this format | ||||
| 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 | |
| CarePlan.category | required | TreatmentTypehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/TreatmentTypefrom this IG | |
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom 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:activity-code.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| CarePlan.activity:activity-code.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |||||
| 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 | |||||
| Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| treatment-line | S | 0..1 | integer | Line number the treatment URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment-line | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment-line" | |||||
| Slices for value[x] | 0..1 | integer | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueInteger | S | 0..1 | integer | Line number the treatment | ||||
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier | Σ | 0..* | Identifier | External Ids for this plan | ||||
| instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn | ΣC | 0..* | Reference(CarePlan) | Fulfills CarePlan ref-1: SHALL have a contained resource if a local reference is provided | ||||
| replaces | ΣC | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan ref-1: SHALL have a contained resource if a local reference is provided | ||||
| partOf | ΣC | 0..* | Reference(CarePlan) | Part of referenced CarePlan ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 | SΣ | 1..1 | CodeableConcept | Type of treatment Binding: Treatment Type Value Set (required) | ||||
| title | Σ | 0..1 | string | Human-friendly name for the care plan | ||||
| description | Σ | 0..1 | string | Summary of nature of plan | ||||
| subject | SΣC | 1..1 | Reference(Oncology Patient) | Who the care plan is for ref-1: SHALL have a contained resource if a local reference is provided | ||||
| encounter | ΣC | 0..1 | Reference(Encounter) | Encounter created as part of ref-1: SHALL have a contained resource if a local reference is provided | ||||
| period | ΣC | 0..1 | Period | Time period plan covers per-1: If present, start SHALL have a lower value than end | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| start | SΣC | 1..1 | dateTime | Start date | ||||
| end | SΣC | 1..1 | dateTime | End date | ||||
| created | Σ | 0..1 | dateTime | Date record was first recorded | ||||
| author | ΣC | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who is the designated responsible party ref-1: SHALL have a contained resource if a local reference is provided | ||||
| contributor | C | 0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan ref-1: SHALL have a contained resource if a local reference is provided | ||||
| careTeam | C | 0..* | Reference(CareTeam) | Who's involved in plan? ref-1: SHALL have a contained resource if a local reference is provided | ||||
| addresses | ΣC | 0..* | Reference(Condition) | Health issues this plan addresses ref-1: SHALL have a contained resource if a local reference is provided | ||||
| supportingInfo | C | 0..1 | Reference(Oncology Clinical Trial) | Objective of the treatment ref-1: SHALL have a contained resource if a local reference is provided | ||||
| goal | C | 0..* | Reference(Goal) | Desired outcome of plan ref-1: SHALL have a contained resource if a local reference is provided | ||||
| Slices for activity | C | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by pattern:detail.code.coding.system cpl-3: Provide a reference or detail, not both | ||||
| activity:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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 | C | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. ref-1: SHALL have a contained resource if a local reference is provided | ||||
| progress | 0..* | Annotation | Comments about the activity status/progress | |||||
| reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource ref-1: SHALL have a contained resource if a local reference is provided | ||||
| detail | C | 0..1 | BackboneElement | In-line definition of activity | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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(PlanDefinition | ActivityDefinition | Questionnaire | Measure | 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 | SC | 0..* | Reference(Tumor Pathology Event) | Why activity is needed ref-1: SHALL have a contained resource if a local reference is provided | ||||
| goal | C | 0..* | Reference(Goal) | Goals this activity relates to ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 | C | 0..1 | Reference(Location) | Where it should happen ref-1: SHALL have a contained resource if a local reference is provided | ||||
| performer | C | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? ref-1: SHALL have a contained resource if a local reference is provided | ||||
| product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
| productCodeableConcept | CodeableConcept | |||||||
| productReference | Reference(Medication | Substance) | |||||||
| dailyAmount | C | 0..1 | SimpleQuantity | How to consume/day? qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
| quantity | C | 0..1 | SimpleQuantity | How much to administer/supply/consume qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
| description | 0..1 | string | Extra info describing activity to perform | |||||
| activity:activity-code | C | 0..1 | BackboneElement | Classification Commune des Actes Médicaux (CCAM) code of the medical act cpl-3: Provide a reference or detail, not both | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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 | C | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. ref-1: SHALL have a contained resource if a local reference is provided | ||||
| progress | 0..* | Annotation | Comments about the activity status/progress | |||||
| reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource ref-1: SHALL have a contained resource if a local reference is provided | ||||
| detail | C | 1..1 | BackboneElement | In-line definition of activity | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |||||
| code | 1..1 | CodeableConcept | CCAM code of the medical act Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.atih.sante.fr/les-versions-de-la-ccam | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| 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 | C | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed ref-1: SHALL have a contained resource if a local reference is provided | ||||
| goal | C | 0..* | Reference(Goal) | Goals this activity relates to ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 | C | 0..1 | Reference(Location) | Where it should happen ref-1: SHALL have a contained resource if a local reference is provided | ||||
| performer | C | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? ref-1: SHALL have a contained resource if a local reference is provided | ||||
| product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
| productCodeableConcept | CodeableConcept | |||||||
| productReference | Reference(Medication | Substance) | |||||||
| dailyAmount | C | 0..1 | SimpleQuantity | How to consume/day? qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
| quantity | C | 0..1 | SimpleQuantity | How much to administer/supply/consume qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
| 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 | required | TreatmentTypehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/TreatmentTypefrom this IG | ||||
| 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 | ||||
| CarePlan.activity:activity-code.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcomefrom the FHIR Standard | ||||
| CarePlan.activity:activity-code.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1from the FHIR Standard | ||||
| CarePlan.activity:activity-code.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| CarePlan.activity:activity-code.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| CarePlan.activity:activity-code.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard | ||||
| CarePlan.activity:activity-code.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard |
This structure is derived from CarePlan
Summary
Mandatory: 1 element (5 nested mandatory elements)
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
| treatment-line | S | 0..1 | integer | Line number the treatment URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment-line |
| value[x]:valueInteger | 0..1 | integer | Line number the treatment | |
| category | S | 1..1 | CodeableConcept | Type of treatment Binding: Treatment Type Value Set (required) |
| subject | S | 1..1 | Reference(Oncology Patient) | Who the care plan is for |
| period | ||||
| start | S | 1..1 | dateTime | Start date |
| end | S | 1..1 | dateTime | End date |
| supportingInfo | 0..1 | Reference(Oncology Clinical Trial) | Objective of the treatment | |
| Slices for activity | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by pattern:detail.code.coding.system | |
| activity:All Slices | Content/Rules for all slices | |||
| detail | ||||
| code | 0..1 | CodeableConcept | Detail type of activity | |
| reasonReference | S | 0..* | Reference(Tumor Pathology Event) | Why activity is needed |
| activity:activity-code | 0..1 | BackboneElement | Classification Commune des Actes Médicaux (CCAM) code of the medical act | |
| detail | 1..1 | BackboneElement | In-line definition of activity | |
| code | 1..1 | CodeableConcept | CCAM code of the medical act | |
| coding | ||||
| system | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.atih.sante.fr/les-versions-de-la-ccam | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.category | required | TreatmentTypehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/TreatmentTypefrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| treatment-line | S | 0..1 | integer | Line number the treatment URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment-line |
| extension | 0..0 | |||
| url | 1..1 | uri | "https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment-line" | |
| Slices for value[x] | 0..1 | integer | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueInteger | S | 0..1 | integer | Line number the treatment |
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| 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 | SΣ | 1..1 | CodeableConcept | Type of treatment Binding: Treatment Type Value Set (required) |
| subject | SΣC | 1..1 | Reference(Oncology Patient) | Who the care plan is for ref-1: SHALL have a contained resource if a local reference is provided |
| period | ΣC | 0..1 | Period | Time period plan covers per-1: If present, start SHALL have a lower value than end |
| start | SΣC | 1..1 | dateTime | Start date |
| end | SΣC | 1..1 | dateTime | End date |
| supportingInfo | C | 0..1 | Reference(Oncology Clinical Trial) | Objective of the treatment ref-1: SHALL have a contained resource if a local reference is provided |
| Slices for activity | C | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by pattern:detail.code.coding.system cpl-3: Provide a reference or detail, not both |
| activity:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource ref-1: SHALL have a contained resource if a local reference is provided |
| detail | C | 0..1 | BackboneElement | In-line definition of activity |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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. | |
| reasonReference | SC | 0..* | Reference(Tumor Pathology Event) | Why activity is needed ref-1: SHALL have a contained resource if a local reference is provided |
| 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. |
| doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action |
| activity:activity-code | C | 0..1 | BackboneElement | Classification Commune des Actes Médicaux (CCAM) code of the medical act cpl-3: Provide a reference or detail, not both |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource ref-1: SHALL have a contained resource if a local reference is provided |
| detail | C | 1..1 | BackboneElement | In-line definition of activity |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | 1..1 | CodeableConcept | CCAM code of the medical act Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |
| 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. |
| doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action |
| Documentation for this format | ||||
| 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 | |
| CarePlan.category | required | TreatmentTypehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/TreatmentTypefrom this IG | |
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom 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:activity-code.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| CarePlan.activity:activity-code.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |||||
| 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 | |||||
| Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| treatment-line | S | 0..1 | integer | Line number the treatment URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment-line | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/treatment-line" | |||||
| Slices for value[x] | 0..1 | integer | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueInteger | S | 0..1 | integer | Line number the treatment | ||||
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier | Σ | 0..* | Identifier | External Ids for this plan | ||||
| instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn | ΣC | 0..* | Reference(CarePlan) | Fulfills CarePlan ref-1: SHALL have a contained resource if a local reference is provided | ||||
| replaces | ΣC | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan ref-1: SHALL have a contained resource if a local reference is provided | ||||
| partOf | ΣC | 0..* | Reference(CarePlan) | Part of referenced CarePlan ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 | SΣ | 1..1 | CodeableConcept | Type of treatment Binding: Treatment Type Value Set (required) | ||||
| title | Σ | 0..1 | string | Human-friendly name for the care plan | ||||
| description | Σ | 0..1 | string | Summary of nature of plan | ||||
| subject | SΣC | 1..1 | Reference(Oncology Patient) | Who the care plan is for ref-1: SHALL have a contained resource if a local reference is provided | ||||
| encounter | ΣC | 0..1 | Reference(Encounter) | Encounter created as part of ref-1: SHALL have a contained resource if a local reference is provided | ||||
| period | ΣC | 0..1 | Period | Time period plan covers per-1: If present, start SHALL have a lower value than end | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| start | SΣC | 1..1 | dateTime | Start date | ||||
| end | SΣC | 1..1 | dateTime | End date | ||||
| created | Σ | 0..1 | dateTime | Date record was first recorded | ||||
| author | ΣC | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who is the designated responsible party ref-1: SHALL have a contained resource if a local reference is provided | ||||
| contributor | C | 0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan ref-1: SHALL have a contained resource if a local reference is provided | ||||
| careTeam | C | 0..* | Reference(CareTeam) | Who's involved in plan? ref-1: SHALL have a contained resource if a local reference is provided | ||||
| addresses | ΣC | 0..* | Reference(Condition) | Health issues this plan addresses ref-1: SHALL have a contained resource if a local reference is provided | ||||
| supportingInfo | C | 0..1 | Reference(Oncology Clinical Trial) | Objective of the treatment ref-1: SHALL have a contained resource if a local reference is provided | ||||
| goal | C | 0..* | Reference(Goal) | Desired outcome of plan ref-1: SHALL have a contained resource if a local reference is provided | ||||
| Slices for activity | C | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by pattern:detail.code.coding.system cpl-3: Provide a reference or detail, not both | ||||
| activity:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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 | C | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. ref-1: SHALL have a contained resource if a local reference is provided | ||||
| progress | 0..* | Annotation | Comments about the activity status/progress | |||||
| reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource ref-1: SHALL have a contained resource if a local reference is provided | ||||
| detail | C | 0..1 | BackboneElement | In-line definition of activity | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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(PlanDefinition | ActivityDefinition | Questionnaire | Measure | 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 | SC | 0..* | Reference(Tumor Pathology Event) | Why activity is needed ref-1: SHALL have a contained resource if a local reference is provided | ||||
| goal | C | 0..* | Reference(Goal) | Goals this activity relates to ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 | C | 0..1 | Reference(Location) | Where it should happen ref-1: SHALL have a contained resource if a local reference is provided | ||||
| performer | C | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? ref-1: SHALL have a contained resource if a local reference is provided | ||||
| product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
| productCodeableConcept | CodeableConcept | |||||||
| productReference | Reference(Medication | Substance) | |||||||
| dailyAmount | C | 0..1 | SimpleQuantity | How to consume/day? qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
| quantity | C | 0..1 | SimpleQuantity | How much to administer/supply/consume qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
| description | 0..1 | string | Extra info describing activity to perform | |||||
| activity:activity-code | C | 0..1 | BackboneElement | Classification Commune des Actes Médicaux (CCAM) code of the medical act cpl-3: Provide a reference or detail, not both | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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 | C | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. ref-1: SHALL have a contained resource if a local reference is provided | ||||
| progress | 0..* | Annotation | Comments about the activity status/progress | |||||
| reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource ref-1: SHALL have a contained resource if a local reference is provided | ||||
| detail | C | 1..1 | BackboneElement | In-line definition of activity | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |||||
| code | 1..1 | CodeableConcept | CCAM code of the medical act Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.atih.sante.fr/les-versions-de-la-ccam | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| 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 | C | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed ref-1: SHALL have a contained resource if a local reference is provided | ||||
| goal | C | 0..* | Reference(Goal) | Goals this activity relates to ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 | C | 0..1 | Reference(Location) | Where it should happen ref-1: SHALL have a contained resource if a local reference is provided | ||||
| performer | C | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? ref-1: SHALL have a contained resource if a local reference is provided | ||||
| product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
| productCodeableConcept | CodeableConcept | |||||||
| productReference | Reference(Medication | Substance) | |||||||
| dailyAmount | C | 0..1 | SimpleQuantity | How to consume/day? qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
| quantity | C | 0..1 | SimpleQuantity | How much to administer/supply/consume qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
| 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 | required | TreatmentTypehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/TreatmentTypefrom this IG | ||||
| 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 | ||||
| CarePlan.activity:activity-code.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcomefrom the FHIR Standard | ||||
| CarePlan.activity:activity-code.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1from the FHIR Standard | ||||
| CarePlan.activity:activity-code.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| CarePlan.activity:activity-code.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| CarePlan.activity:activity-code.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard | ||||
| CarePlan.activity:activity-code.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard |
This structure is derived from CarePlan
Summary
Mandatory: 1 element (5 nested mandatory elements)
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ Arkhn. Package arkhn.fhir.uv.osiris#2.1.0 based on FHIR 4.0.1. Generated 2024-03-21
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change