Care Coordination Management
0.0.1 - ci-build Estonia (EST)

Care Coordination Management, published by Helex OÜ. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/helexlab/ig-ccm/ and changes regularly. See the Directory of published versions

Resource Profile: ProcedureCcm

Official URL: http://helex.org/ig/ccm/StructureDefinition/procedure-ccm Version: 0.0.1
Draft as of 2025-12-05 Computable Name: ProcedureCcm

A localized profile of Procedure for use in CCM.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... 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
... code SΣ 1..1 CodeableConcept Identification of the procedure
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-task-type--1.0.0 (required)
... subject SΣ 1..1 Reference(PatientCcm) Individual or entity the procedure was performed on
... Slices for occurrence[x] Σ 1..1 dateTime When the procedure occurred or is occurring
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ 1..1 dateTime When the procedure occurred or is occurring
... performer SΣC 1..1 BackboneElement Who performed the procedure and what they did
Constraints: prc-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣC 1..1 Reference(PractitionerCcm) Who performed the procedure
... outcome SΣ 1..1 CodeableConcept The result of procedure
Binding: ProcedureOutcomeCodesSNOMEDCT (example): An outcome of a procedure - whether it was resolved or otherwise.
... note S 0..1 Annotation Additional information about the procedure
... supportingInfo S 0..1 Reference(ResearchSubjectCcm) Extra information relevant to the procedure

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Procedure.status Base required EventStatus 📍5.0.0 FHIR Std.
Procedure.code Base required https://dev.termx.org/api/fhir/ValueSet/ccm-task-type--1.0.0 Not State Unknown
Procedure.outcome Base example Procedure Outcome Codes (SNOMED CT) 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Procedure If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Procedure 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 Procedure 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 Procedure If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Procedure 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()
prc-1 error Procedure.performer Procedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole onBehalfOf.exists() and actor.resolve().exists() implies actor.resolve().where($this is Practitioner or $this is PractitionerRole).empty()

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... status S 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... code S 1..1 CodeableConcept Identification of the procedure
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-task-type--1.0.0 (required)
... subject S 1..1 Reference(PatientCcm) Individual or entity the procedure was performed on
.... occurrence[x]:occurrenceDateTime S 1..1 dateTime When the procedure occurred or is occurring
... performer S 1..1 BackboneElement Who performed the procedure and what they did
.... function 0..0 Type of performance
.... actor S 1..1 Reference(PractitionerCcm) Who performed the procedure
.... onBehalfOf 0..0 Organization the device or practitioner was acting for
.... period 0..0 When the performer performed the procedure
... reason 0..0 The justification that the procedure was performed
... bodySite 0..0 Target body sites
... outcome S 1..1 CodeableConcept The result of procedure
... report 0..0 Any report resulting from the procedure
... complication 0..0 Complication following the procedure
... followUp 0..0 Instructions for follow up
... note S 0..1 Annotation Additional information about the procedure
... focalDevice 0..0 Manipulated, implanted, or removed device
... used 0..0 Items used during procedure
... supportingInfo S 0..1 Reference(ResearchSubjectCcm) Extra information relevant to the procedure

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Procedure.code Base required https://dev.termx.org/api/fhir/ValueSet/ccm-task-type--1.0.0 Not State Unknown
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... 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 Identifiers for this procedure
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest) A request for this procedure
... partOf Σ 0..* Reference(Procedure | Observation | MedicationAdministration) Part of referenced event
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.
... statusReason Σ 0..1 CodeableConcept Reason for current status
Binding: ProcedureNotPerformedReasonSNOMEDCT (example): A code that identifies the reason a procedure was not performed.
... category Σ 0..* CodeableConcept Classification of the procedure
Binding: ProcedureCategoryCodesSNOMEDCT (example): A code that classifies a procedure for searching, sorting and display purposes.
... code SΣ 1..1 CodeableConcept Identification of the procedure
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-task-type--1.0.0 (required)
... subject SΣ 1..1 Reference(PatientCcm) Individual or entity the procedure was performed on
... focus Σ 0..1 Reference(Patient | Group | RelatedPerson | Practitioner | Organization | CareTeam | PractitionerRole | Specimen) Who is the target of the procedure when it is not the subject of record only
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this Procedure was created
... Slices for occurrence[x] Σ 1..1 dateTime When the procedure occurred or is occurring
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ 1..1 dateTime When the procedure occurred or is occurring
... recorded Σ 0..1 dateTime When the procedure was first captured in the subject's record
... recorder Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who recorded the procedure
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)
... performer SΣC 1..1 BackboneElement Who performed the procedure and what they did
Constraints: prc-1
.... 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
.... actor SΣC 1..1 Reference(PractitionerCcm) Who performed the procedure
... location Σ 0..1 Reference(Location) Where the procedure happened
... outcome SΣ 1..1 CodeableConcept The result of procedure
Binding: ProcedureOutcomeCodesSNOMEDCT (example): An outcome of a procedure - whether it was resolved or otherwise.
... note S 0..1 Annotation Additional information about the procedure
... supportingInfo S 0..1 Reference(ResearchSubjectCcm) Extra information relevant to the procedure

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Procedure.language Base required All Languages 📍5.0.0 FHIR Std.
Procedure.status Base required EventStatus 📍5.0.0 FHIR Std.
Procedure.statusReason Base example Procedure Not Performed Reason (SNOMED-CT) 📍5.0.0 FHIR Std.
Procedure.category Base example Procedure Category Codes (SNOMED CT) 📍5.0.0 FHIR Std.
Procedure.code Base required https://dev.termx.org/api/fhir/ValueSet/ccm-task-type--1.0.0 Not State Unknown
Procedure.outcome Base example Procedure Outcome Codes (SNOMED CT) 📍5.0.0 FHIR Std.
Procedure.focalDevice.​action Base preferred Procedure Device Action Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Procedure If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Procedure 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 Procedure 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 Procedure If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Procedure 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()
prc-1 error Procedure.performer Procedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole onBehalfOf.exists() and actor.resolve().exists() implies actor.resolve().where($this is Practitioner or $this is PractitionerRole).empty()

This structure is derived from Procedure

Summary

Mandatory: 5 elements
Must-Support: 9 elements
Prohibited: 10 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Procedure.occurrence[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... 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
... code SΣ 1..1 CodeableConcept Identification of the procedure
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-task-type--1.0.0 (required)
... subject SΣ 1..1 Reference(PatientCcm) Individual or entity the procedure was performed on
... Slices for occurrence[x] Σ 1..1 dateTime When the procedure occurred or is occurring
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ 1..1 dateTime When the procedure occurred or is occurring
... performer SΣC 1..1 BackboneElement Who performed the procedure and what they did
Constraints: prc-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣC 1..1 Reference(PractitionerCcm) Who performed the procedure
... outcome SΣ 1..1 CodeableConcept The result of procedure
Binding: ProcedureOutcomeCodesSNOMEDCT (example): An outcome of a procedure - whether it was resolved or otherwise.
... note S 0..1 Annotation Additional information about the procedure
... supportingInfo S 0..1 Reference(ResearchSubjectCcm) Extra information relevant to the procedure

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Procedure.status Base required EventStatus 📍5.0.0 FHIR Std.
Procedure.code Base required https://dev.termx.org/api/fhir/ValueSet/ccm-task-type--1.0.0 Not State Unknown
Procedure.outcome Base example Procedure Outcome Codes (SNOMED CT) 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Procedure If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Procedure 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 Procedure 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 Procedure If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Procedure 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()
prc-1 error Procedure.performer Procedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole onBehalfOf.exists() and actor.resolve().exists() implies actor.resolve().where($this is Practitioner or $this is PractitionerRole).empty()

Differential View

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... status S 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... code S 1..1 CodeableConcept Identification of the procedure
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-task-type--1.0.0 (required)
... subject S 1..1 Reference(PatientCcm) Individual or entity the procedure was performed on
.... occurrence[x]:occurrenceDateTime S 1..1 dateTime When the procedure occurred or is occurring
... performer S 1..1 BackboneElement Who performed the procedure and what they did
.... function 0..0 Type of performance
.... actor S 1..1 Reference(PractitionerCcm) Who performed the procedure
.... onBehalfOf 0..0 Organization the device or practitioner was acting for
.... period 0..0 When the performer performed the procedure
... reason 0..0 The justification that the procedure was performed
... bodySite 0..0 Target body sites
... outcome S 1..1 CodeableConcept The result of procedure
... report 0..0 Any report resulting from the procedure
... complication 0..0 Complication following the procedure
... followUp 0..0 Instructions for follow up
... note S 0..1 Annotation Additional information about the procedure
... focalDevice 0..0 Manipulated, implanted, or removed device
... used 0..0 Items used during procedure
... supportingInfo S 0..1 Reference(ResearchSubjectCcm) Extra information relevant to the procedure

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Procedure.code Base required https://dev.termx.org/api/fhir/ValueSet/ccm-task-type--1.0.0 Not State Unknown

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... 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 Identifiers for this procedure
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest) A request for this procedure
... partOf Σ 0..* Reference(Procedure | Observation | MedicationAdministration) Part of referenced event
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.
... statusReason Σ 0..1 CodeableConcept Reason for current status
Binding: ProcedureNotPerformedReasonSNOMEDCT (example): A code that identifies the reason a procedure was not performed.
... category Σ 0..* CodeableConcept Classification of the procedure
Binding: ProcedureCategoryCodesSNOMEDCT (example): A code that classifies a procedure for searching, sorting and display purposes.
... code SΣ 1..1 CodeableConcept Identification of the procedure
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-task-type--1.0.0 (required)
... subject SΣ 1..1 Reference(PatientCcm) Individual or entity the procedure was performed on
... focus Σ 0..1 Reference(Patient | Group | RelatedPerson | Practitioner | Organization | CareTeam | PractitionerRole | Specimen) Who is the target of the procedure when it is not the subject of record only
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this Procedure was created
... Slices for occurrence[x] Σ 1..1 dateTime When the procedure occurred or is occurring
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ 1..1 dateTime When the procedure occurred or is occurring
... recorded Σ 0..1 dateTime When the procedure was first captured in the subject's record
... recorder Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who recorded the procedure
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)
... performer SΣC 1..1 BackboneElement Who performed the procedure and what they did
Constraints: prc-1
.... 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
.... actor SΣC 1..1 Reference(PractitionerCcm) Who performed the procedure
... location Σ 0..1 Reference(Location) Where the procedure happened
... outcome SΣ 1..1 CodeableConcept The result of procedure
Binding: ProcedureOutcomeCodesSNOMEDCT (example): An outcome of a procedure - whether it was resolved or otherwise.
... note S 0..1 Annotation Additional information about the procedure
... supportingInfo S 0..1 Reference(ResearchSubjectCcm) Extra information relevant to the procedure

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Procedure.language Base required All Languages 📍5.0.0 FHIR Std.
Procedure.status Base required EventStatus 📍5.0.0 FHIR Std.
Procedure.statusReason Base example Procedure Not Performed Reason (SNOMED-CT) 📍5.0.0 FHIR Std.
Procedure.category Base example Procedure Category Codes (SNOMED CT) 📍5.0.0 FHIR Std.
Procedure.code Base required https://dev.termx.org/api/fhir/ValueSet/ccm-task-type--1.0.0 Not State Unknown
Procedure.outcome Base example Procedure Outcome Codes (SNOMED CT) 📍5.0.0 FHIR Std.
Procedure.focalDevice.​action Base preferred Procedure Device Action Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Procedure If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Procedure 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 Procedure 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 Procedure If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Procedure 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()
prc-1 error Procedure.performer Procedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole onBehalfOf.exists() and actor.resolve().exists() implies actor.resolve().where($this is Practitioner or $this is PractitionerRole).empty()

This structure is derived from Procedure

Summary

Mandatory: 5 elements
Must-Support: 9 elements
Prohibited: 10 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Procedure.occurrence[x]

 

Other representations of profile: CSV, Excel, Schematron