Search FHIR

FHIR Osiris Implementation Guide
1.1.0 - trial-implementation

This page is part of the OSIRIS FHIR Implementation Guide (v1.1.0: Release) 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

Resource Profile: Treatment

Official URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/treatment Version: 1.1.0
Draft as of 2025-04-03 Computable Name: Treatment

Description of a treatment plan related to an Oncology Patient.

Usage:

Formal Views of Profile Content

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

NomDrapeauxCard.TypeDescription et contraintesdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices pour extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:treatment-line S 0..1 (Complex) Line number the treatment
URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/treatment-line
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension 0..0
..... url 1..1 uri "https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/treatment-line"
..... Slices pour value[x] 0..1 integer Value of extension
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
...... value[x]:valueInteger S 0..1 integer Line number the treatment
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... intent ?!Σ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.


ele-1: All FHIR elements must have a @value or children
... category SΣ 1..1 CodeableConcept Type of treatment
Binding: Treatment Type Value Set (required)
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(Oncology Patient) Who the care plan is for
ele-1: All FHIR elements must have a @value or children
... period Σ 0..1 Period Time period plan covers
ele-1: All FHIR elements must have a @value or children
.... start SΣC 1..1 dateTime Start date
ele-1: All FHIR elements must have a @value or children
.... end SΣC 1..1 dateTime End date
ele-1: All FHIR elements must have a @value or children
... supportingInfo 0..1 Reference(Oncology Clinical Trial) Objective of the treatment
ele-1: All FHIR elements must have a @value or children
... Slices pour 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
ele-1: All FHIR elements must have a @value or children
.... activity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... detail C 0..1 BackboneElement In-line definition of activity
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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.


ele-1: All FHIR elements must have a @value or children
...... reasonReference S 0..* Reference(Tumor Pathology Event) Why activity is needed
ele-1: All FHIR elements must have a @value or children
...... 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.


ele-1: All FHIR elements must have a @value or children
...... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
ele-1: All FHIR elements must have a @value or children
.... 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
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... detail C 1..1 BackboneElement In-line definition of activity
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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.


ele-1: All FHIR elements must have a @value or children
...... reasonReference S 0..* Reference(Tumor Pathology Event) Why activity is needed
ele-1: All FHIR elements must have a @value or children
...... 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.


ele-1: All FHIR elements must have a @value or children
...... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformitéValueSetURI
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryrequiredTreatmentType
https://ig-osiris.cancer.fr/ig/osiris/ValueSet/TreatmentType
from this IG
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard
CarePlan.activity:activity-code.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
CarePlan.activity:activity-code.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard

This structure is derived from CarePlan

NomDrapeauxCard.TypeDescription et contraintesdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... Slices pour extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:treatment-line S 0..1 (Complex) Line number the treatment
URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/treatment-line
..... Slices pour value[x] Content/Rules for all slices
...... 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
.... 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 pour 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformitéValueSetURI
CarePlan.categoryrequiredTreatmentType
https://ig-osiris.cancer.fr/ig/osiris/ValueSet/TreatmentType
from this IG
NomDrapeauxCard.TypeDescription et contraintesdoco
.. 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.

Bindings AdditionnelsBut
AllLanguages Binding Max
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices pour extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:treatment-line S 0..1 (Complex) Line number the treatment
URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/treatment-line
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/treatment-line"
..... Slices pour 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 ?! 0..* Extension Extensions that cannot be ignored
... 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 Σ 0..* Reference(CarePlan) Fulfills CarePlan
... replaces Σ 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(CarePlan) 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 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Σ 1..1 Reference(Oncology Patient) Who the care plan is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... period Σ 0..1 Period Time period plan covers
.... id 0..1 string Unique id for inter-element referencing
.... extension 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 Σ 0..1 Reference(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..1 Reference(Oncology Clinical Trial) Objective of the treatment
... goal 0..* Reference(Goal) Desired outcome of plan
... Slices pour 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 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 | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | 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(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 S 0..* Reference(Tumor Pathology Event) Why activity is needed
...... goal 0..* Reference(Goal) 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(Location) Where it should happen
...... performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
...... 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 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
.... 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 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 | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
..... detail C 1..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(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 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 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 S 0..* Reference(Tumor Pathology Event) Why activity is needed
...... goal 0..* Reference(Goal) 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(Location) Where it should happen
...... performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
...... 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 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

doco Documentation for this format

Terminology Bindings

PathConformitéValueSetURI
CarePlan.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bindings Additionnels But
AllLanguages Binding Max
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryrequiredTreatmentType
https://ig-osiris.cancer.fr/ig/osiris/ValueSet/TreatmentType
from this IG
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome
from the FHIR Standard
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1
from the FHIR Standard
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
CarePlan.activity:activity-code.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome
from the FHIR Standard
CarePlan.activity:activity-code.detail.kindrequiredCarePlanActivityKind
http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1
from the FHIR Standard
CarePlan.activity:activity-code.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
CarePlan.activity:activity-code.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
CarePlan.activity:activity-code.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard
CarePlan.activity:activity-code.detail.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard

This structure is derived from CarePlan

Résumé

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:

  • The element 1 is sliced based on the value of CarePlan.activity

Key Elements View

NomDrapeauxCard.TypeDescription et contraintesdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices pour extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:treatment-line S 0..1 (Complex) Line number the treatment
URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/treatment-line
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension 0..0
..... url 1..1 uri "https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/treatment-line"
..... Slices pour value[x] 0..1 integer Value of extension
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
...... value[x]:valueInteger S 0..1 integer Line number the treatment
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... intent ?!Σ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.


ele-1: All FHIR elements must have a @value or children
... category SΣ 1..1 CodeableConcept Type of treatment
Binding: Treatment Type Value Set (required)
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(Oncology Patient) Who the care plan is for
ele-1: All FHIR elements must have a @value or children
... period Σ 0..1 Period Time period plan covers
ele-1: All FHIR elements must have a @value or children
.... start SΣC 1..1 dateTime Start date
ele-1: All FHIR elements must have a @value or children
.... end SΣC 1..1 dateTime End date
ele-1: All FHIR elements must have a @value or children
... supportingInfo 0..1 Reference(Oncology Clinical Trial) Objective of the treatment
ele-1: All FHIR elements must have a @value or children
... Slices pour 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
ele-1: All FHIR elements must have a @value or children
.... activity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... detail C 0..1 BackboneElement In-line definition of activity
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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.


ele-1: All FHIR elements must have a @value or children
...... reasonReference S 0..* Reference(Tumor Pathology Event) Why activity is needed
ele-1: All FHIR elements must have a @value or children
...... 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.


ele-1: All FHIR elements must have a @value or children
...... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
ele-1: All FHIR elements must have a @value or children
.... 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
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... detail C 1..1 BackboneElement In-line definition of activity
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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.


ele-1: All FHIR elements must have a @value or children
...... reasonReference S 0..* Reference(Tumor Pathology Event) Why activity is needed
ele-1: All FHIR elements must have a @value or children
...... 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.


ele-1: All FHIR elements must have a @value or children
...... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformitéValueSetURI
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryrequiredTreatmentType
https://ig-osiris.cancer.fr/ig/osiris/ValueSet/TreatmentType
from this IG
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard
CarePlan.activity:activity-code.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
CarePlan.activity:activity-code.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard

Differential View

This structure is derived from CarePlan

NomDrapeauxCard.TypeDescription et contraintesdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... Slices pour extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:treatment-line S 0..1 (Complex) Line number the treatment
URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/treatment-line
..... Slices pour value[x] Content/Rules for all slices
...... 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
.... 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 pour 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformitéValueSetURI
CarePlan.categoryrequiredTreatmentType
https://ig-osiris.cancer.fr/ig/osiris/ValueSet/TreatmentType
from this IG

Snapshot View

NomDrapeauxCard.TypeDescription et contraintesdoco
.. 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.

Bindings AdditionnelsBut
AllLanguages Binding Max
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices pour extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:treatment-line S 0..1 (Complex) Line number the treatment
URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/treatment-line
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/treatment-line"
..... Slices pour 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 ?! 0..* Extension Extensions that cannot be ignored
... 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 Σ 0..* Reference(CarePlan) Fulfills CarePlan
... replaces Σ 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(CarePlan) 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 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Σ 1..1 Reference(Oncology Patient) Who the care plan is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... period Σ 0..1 Period Time period plan covers
.... id 0..1 string Unique id for inter-element referencing
.... extension 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 Σ 0..1 Reference(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..1 Reference(Oncology Clinical Trial) Objective of the treatment
... goal 0..* Reference(Goal) Desired outcome of plan
... Slices pour 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 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 | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | 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(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 S 0..* Reference(Tumor Pathology Event) Why activity is needed
...... goal 0..* Reference(Goal) 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(Location) Where it should happen
...... performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
...... 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 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
.... 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 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 | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
..... detail C 1..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(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 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 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 S 0..* Reference(Tumor Pathology Event) Why activity is needed
...... goal 0..* Reference(Goal) 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(Location) Where it should happen
...... performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
...... 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 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

doco Documentation for this format

Terminology Bindings

PathConformitéValueSetURI
CarePlan.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bindings Additionnels But
AllLanguages Binding Max
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryrequiredTreatmentType
https://ig-osiris.cancer.fr/ig/osiris/ValueSet/TreatmentType
from this IG
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome
from the FHIR Standard
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1
from the FHIR Standard
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
CarePlan.activity:activity-code.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome
from the FHIR Standard
CarePlan.activity:activity-code.detail.kindrequiredCarePlanActivityKind
http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1
from the FHIR Standard
CarePlan.activity:activity-code.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
CarePlan.activity:activity-code.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
CarePlan.activity:activity-code.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard
CarePlan.activity:activity-code.detail.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard

This structure is derived from CarePlan

Résumé

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:

  • The element 1 is sliced based on the value of CarePlan.activity

 

Other representations of profile: CSV, Excel, Schematron