HL7 Europe Imaging Report R5
1.0.0-ballot - ballot 150

This page is part of the HL7 Europe Imaging Study Report (v1.0.0-ballot: STU 1 Ballot 2) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: EuCarePlan: Obligations

Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/care-plan-obligation-eu-imaging Version: 1.0.0-ballot
Computable Name: CarePlanObligationEuImaging

Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).

Obligations for EuCarePlan

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... intent ?!Σ 1..1 code proposal | plan | order | option | directive
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... description OΣ 0..1 string Summary of nature of plan
ObligationsActor
SHOULD:able-to-populate Imaging Report provider
... subject Σ 1..1 Reference(Patient | Group) Who the care plan is for

doco Documentation for this format
NameImaging Report providerdoco
.. CarePlan
... description

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.status Base required RequestStatus 📍5.0.0 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... description O 0..1 string Summary of nature of plan
ObligationsActor
SHOULD:able-to-populate Imaging Report provider

doco Documentation for this format
NameImaging Report providerdoco
.. CarePlan
... description

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this plan
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | RequestOrchestration | NutritionOrder) Fulfills plan, proposal or order
... 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 | directive
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... category Σ 0..* CodeableConcept Type of plan
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.
... title Σ 0..1 string Human-friendly name for the care plan
... description OΣ 0..1 string Summary of nature of plan
ObligationsActor
SHOULD:able-to-populate Imaging Report provider
... subject Σ 1..1 Reference(Patient | Group) Who the care plan is for
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this CarePlan was created
... period Σ 0..1 Period Time period plan covers
... created Σ 0..1 dateTime Date record was first recorded
... custodian Σ 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..* CodeableReference(Condition) Health issues this plan addresses
Binding: SNOMEDCTClinicalFindings (example): Codes that describe the health issues this plan addresses.
... supportingInfo 0..* Reference(Resource) Information considered as part of plan
... goal 0..* Reference(Goal) Desired outcome of plan
... activity 0..* BackboneElement Action to occur or has occurred as part of plan
.... 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
.... performedActivity 0..* CodeableReference(Resource) Results of the activity (concept, or Appointment, Encounter, Procedure, etc.)
Binding: CarePlanActivityPerformed (example): Identifies the results of the activity.
.... progress 0..* Annotation Comments about the activity status/progress
.... plannedActivityReference 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestOrchestration | ImmunizationRecommendation | SupplyRequest) Activity that is intended to be part of the care plan
... note 0..* Annotation Comments about the plan

doco Documentation for this format
NameImaging Report providerdoco
.. CarePlan
... description

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.language Base required All Languages 📍5.0.0 FHIR Std.
CarePlan.status Base required RequestStatus 📍5.0.0 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍5.0.0 FHIR Std.
CarePlan.category Base example Care Plan Category 📍5.0.0 FHIR Std.
CarePlan.addresses Base example SNOMED CT Clinical Findings 📍5.0.0 FHIR Std.
CarePlan.activity.performedActivity Base example Care Plan Activity Performed 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... intent ?!Σ 1..1 code proposal | plan | order | option | directive
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... description OΣ 0..1 string Summary of nature of plan
ObligationsActor
SHOULD:able-to-populate Imaging Report provider
... subject Σ 1..1 Reference(Patient | Group) Who the care plan is for

doco Documentation for this format
NameImaging Report providerdoco
.. CarePlan
... description

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.status Base required RequestStatus 📍5.0.0 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... description O 0..1 string Summary of nature of plan
ObligationsActor
SHOULD:able-to-populate Imaging Report provider

doco Documentation for this format
NameImaging Report providerdoco
.. CarePlan
... description

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this plan
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | RequestOrchestration | NutritionOrder) Fulfills plan, proposal or order
... 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 | directive
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... category Σ 0..* CodeableConcept Type of plan
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.
... title Σ 0..1 string Human-friendly name for the care plan
... description OΣ 0..1 string Summary of nature of plan
ObligationsActor
SHOULD:able-to-populate Imaging Report provider
... subject Σ 1..1 Reference(Patient | Group) Who the care plan is for
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this CarePlan was created
... period Σ 0..1 Period Time period plan covers
... created Σ 0..1 dateTime Date record was first recorded
... custodian Σ 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..* CodeableReference(Condition) Health issues this plan addresses
Binding: SNOMEDCTClinicalFindings (example): Codes that describe the health issues this plan addresses.
... supportingInfo 0..* Reference(Resource) Information considered as part of plan
... goal 0..* Reference(Goal) Desired outcome of plan
... activity 0..* BackboneElement Action to occur or has occurred as part of plan
.... 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
.... performedActivity 0..* CodeableReference(Resource) Results of the activity (concept, or Appointment, Encounter, Procedure, etc.)
Binding: CarePlanActivityPerformed (example): Identifies the results of the activity.
.... progress 0..* Annotation Comments about the activity status/progress
.... plannedActivityReference 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestOrchestration | ImmunizationRecommendation | SupplyRequest) Activity that is intended to be part of the care plan
... note 0..* Annotation Comments about the plan

doco Documentation for this format
NameImaging Report providerdoco
.. CarePlan
... description

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.language Base required All Languages 📍5.0.0 FHIR Std.
CarePlan.status Base required RequestStatus 📍5.0.0 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍5.0.0 FHIR Std.
CarePlan.category Base example Care Plan Category 📍5.0.0 FHIR Std.
CarePlan.addresses Base example SNOMED CT Clinical Findings 📍5.0.0 FHIR Std.
CarePlan.activity.performedActivity Base example Care Plan Activity Performed 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

 

Other representations of profile: CSV, Excel, Schematron