MCC eCare Plan Implementation Guide
1.0.0-ballot2 - ballot United States of America flag

This page is part of the MCC eCare Plan Implementation Guide (v1.0.0-ballot2: STU 1 Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: Multiple Chronic Condition Care Plan Procedure

Official URL: http://hl7.org/fhir/us/mcc/StructureDefinition/MCCProcedure Version: 1.0.0-ballot2
Draft as of 2020-07-22 Computable Name: MCCProcedure

This profile constrains US Core Procedure for use in the MCC FHIR Care Plan or other FHIR Care Plans.

The US Core Procedure profile sets minimum expectations for the Procedure resource to record, search, and fetch procedures associated with a patient, including information about a Social Determinants of Health-related procedures. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

In addition to the requirements set forth in US Core Procedure, this derived profile is designed to add requirements to the following elements:

Procedure.extension:resource-pertainsToGoal (Must Support) to encourage linking to the goal the procedure hopes to facilitate and/or to encourage systems to be able to receive and understand a goal linkage if present. Procedue.reasonReference (Must Support) to encourage linking back to the health concern, problem or observation associated with the procedure, and/or to encourage systems to be able to receive and understand a reason for a procedure, if present.

See the MCC Care Plan SDOH Guidance page for more information when exchanging Social Determinants of Health (SDOH) procedures.

Comments are welcome with respect to the pragmatic use of the “Must Support” rules defined on these elements.

No additional value sets were defined for use in this profile beyond the the value set bindings in the US Core Procedure profile, but please see the MCC Procedure and Service Request Value Set library page for guidance on use of procedure terminology in this guide. .

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreProcedureProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*USCoreProcedureProfileAn action that is being or was performed on a patient
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-pertainsToGoal S0..*Reference(Goal)The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources.
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... code 1..1CodeableConceptPlease see the xx Value Set Library (link?) for value sets that are subsets of US Core Procedure Codes that can be used at the Procedure.code element element
... report 0..*Reference(DiagnosticReport | DocumentReference | Composition)Any report resulting from the procedure

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure C0..*USCoreProcedureProfileAn action that is being or was performed on a patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-pertainsToGoal S0..*Reference(Goal)The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources.
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... status ?!SΣC1..1code(USCDI) preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required)
... code SΣ1..1CodeableConceptPlease see the xx Value Set Library (link?) for value sets that are subsets of US Core Procedure Codes that can be used at the Procedure.code element element
Binding: US Core Procedure Codes (extensible): Codes describing the type of Procedure

... subject SΣ1..1Reference(US Core Patient Profile)(USCDI) Who the procedure was performed on
... performed[x] SΣC0..1(USCDI) When the procedure was performed
.... performedDateTimedateTime
... reasonReference SΣ0..*Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference)The procedure.reason.reference should be populated with the health concern or problem for which it is or was performed.
... report 0..*Reference(DiagnosticReport | DocumentReference | Composition)Any report resulting from the procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Procedure.statusrequiredEventStatus
Procedure.codeextensibleUSCoreProcedureCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorProcedureIf 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-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
us-core-7errorProcedurePerformed SHALL be present if the status is 'completed' or 'in-progress'
: (status='completed' or status='in-progress') implies performed.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure C0..*USCoreProcedureProfileAn action that is being or was performed on a patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-pertainsToGoal S0..*Reference(Goal)The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources.
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifiers for this procedure
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(US Core CarePlan Profile | US Core ServiceRequest Profile)(USCDI) A request for this procedure
... partOf Σ0..*Reference(Procedure | Observation | MedicationAdministration)Part of referenced event
... status ?!SΣC1..1code(USCDI) preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required)
... statusReason Σ0..1CodeableConceptReason for current status
Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.

... category Σ0..1CodeableConceptClassification of the procedure
Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes.

... code SΣ1..1CodeableConceptPlease see the xx Value Set Library (link?) for value sets that are subsets of US Core Procedure Codes that can be used at the Procedure.code element element
Binding: US Core Procedure Codes (extensible): Codes describing the type of Procedure

... subject SΣ1..1Reference(US Core Patient Profile)(USCDI) Who the procedure was performed on
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... performed[x] SΣC0..1(USCDI) When the procedure was performed
.... performedDateTimedateTime S
.... performedPeriodPeriod
.... performedStringstring
.... performedAgeAge
.... performedRangeRange
... recorder Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Who recorded the procedure
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Person who asserts this procedure
... performer Σ0..*BackboneElementThe people who performed the procedure
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptType of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)The reference to the practitioner
.... onBehalfOf 0..1Reference(Organization)Organization the device or practitioner was acting for
... location Σ0..1Reference(Location)Where the procedure happened
... reasonCode Σ0..*CodeableConceptCoded reason procedure performed
Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.


... reasonReference SΣ0..*Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference)The procedure.reason.reference should be populated with the health concern or problem for which it is or was performed.
... bodySite Σ0..*CodeableConceptTarget body sites
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... outcome Σ0..1CodeableConceptThe result of procedure
Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.

... report 0..*Reference(DiagnosticReport | DocumentReference | Composition)Any report resulting from the procedure
... complication 0..*CodeableConceptComplication following the procedure
Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.


... complicationDetail 0..*Reference(Condition)A condition that is a result of the procedure
... followUp 0..*CodeableConceptInstructions for follow up
Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures.


... note 0..*AnnotationAdditional information about the procedure
... focalDevice 0..*BackboneElementManipulated, implanted, or removed device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... action 0..1CodeableConceptKind of change to device
Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure.

.... manipulated 1..1Reference(Device)Device that was changed
... usedReference 0..*Reference(Device | Medication | Substance)Items used during procedure
... usedCode 0..*CodeableConceptCoded items used during the procedure
Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Procedure.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Procedure.statusrequiredEventStatus
Procedure.statusReasonexampleProcedureNotPerformedReason(SNOMED-CT)
Procedure.categoryexampleProcedureCategoryCodes(SNOMEDCT)
Procedure.codeextensibleUSCoreProcedureCodes
Procedure.performer.functionexampleProcedurePerformerRoleCodes
Procedure.reasonCodeexampleProcedureReasonCodes
Procedure.bodySiteexampleSNOMEDCTBodyStructures
Procedure.outcomeexampleProcedureOutcomeCodes(SNOMEDCT)
Procedure.complicationexampleCondition/Problem/DiagnosisCodes
Procedure.followUpexampleProcedureFollowUpCodes(SNOMEDCT)
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
Procedure.usedCodeexampleFHIRDeviceTypes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from USCoreProcedureProfile

Summary

Must-Support: 2 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from USCoreProcedureProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*USCoreProcedureProfileAn action that is being or was performed on a patient
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-pertainsToGoal S0..*Reference(Goal)The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources.
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... code 1..1CodeableConceptPlease see the xx Value Set Library (link?) for value sets that are subsets of US Core Procedure Codes that can be used at the Procedure.code element element
... report 0..*Reference(DiagnosticReport | DocumentReference | Composition)Any report resulting from the procedure

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure C0..*USCoreProcedureProfileAn action that is being or was performed on a patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-pertainsToGoal S0..*Reference(Goal)The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources.
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... status ?!SΣC1..1code(USCDI) preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required)
... code SΣ1..1CodeableConceptPlease see the xx Value Set Library (link?) for value sets that are subsets of US Core Procedure Codes that can be used at the Procedure.code element element
Binding: US Core Procedure Codes (extensible): Codes describing the type of Procedure

... subject SΣ1..1Reference(US Core Patient Profile)(USCDI) Who the procedure was performed on
... performed[x] SΣC0..1(USCDI) When the procedure was performed
.... performedDateTimedateTime
... reasonReference SΣ0..*Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference)The procedure.reason.reference should be populated with the health concern or problem for which it is or was performed.
... report 0..*Reference(DiagnosticReport | DocumentReference | Composition)Any report resulting from the procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Procedure.statusrequiredEventStatus
Procedure.codeextensibleUSCoreProcedureCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorProcedureIf 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-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
us-core-7errorProcedurePerformed SHALL be present if the status is 'completed' or 'in-progress'
: (status='completed' or status='in-progress') implies performed.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure C0..*USCoreProcedureProfileAn action that is being or was performed on a patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-pertainsToGoal S0..*Reference(Goal)The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources.
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifiers for this procedure
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(US Core CarePlan Profile | US Core ServiceRequest Profile)(USCDI) A request for this procedure
... partOf Σ0..*Reference(Procedure | Observation | MedicationAdministration)Part of referenced event
... status ?!SΣC1..1code(USCDI) preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required)
... statusReason Σ0..1CodeableConceptReason for current status
Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.

... category Σ0..1CodeableConceptClassification of the procedure
Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes.

... code SΣ1..1CodeableConceptPlease see the xx Value Set Library (link?) for value sets that are subsets of US Core Procedure Codes that can be used at the Procedure.code element element
Binding: US Core Procedure Codes (extensible): Codes describing the type of Procedure

... subject SΣ1..1Reference(US Core Patient Profile)(USCDI) Who the procedure was performed on
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... performed[x] SΣC0..1(USCDI) When the procedure was performed
.... performedDateTimedateTime S
.... performedPeriodPeriod
.... performedStringstring
.... performedAgeAge
.... performedRangeRange
... recorder Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Who recorded the procedure
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Person who asserts this procedure
... performer Σ0..*BackboneElementThe people who performed the procedure
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptType of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)The reference to the practitioner
.... onBehalfOf 0..1Reference(Organization)Organization the device or practitioner was acting for
... location Σ0..1Reference(Location)Where the procedure happened
... reasonCode Σ0..*CodeableConceptCoded reason procedure performed
Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.


... reasonReference SΣ0..*Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference)The procedure.reason.reference should be populated with the health concern or problem for which it is or was performed.
... bodySite Σ0..*CodeableConceptTarget body sites
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... outcome Σ0..1CodeableConceptThe result of procedure
Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.

... report 0..*Reference(DiagnosticReport | DocumentReference | Composition)Any report resulting from the procedure
... complication 0..*CodeableConceptComplication following the procedure
Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.


... complicationDetail 0..*Reference(Condition)A condition that is a result of the procedure
... followUp 0..*CodeableConceptInstructions for follow up
Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures.


... note 0..*AnnotationAdditional information about the procedure
... focalDevice 0..*BackboneElementManipulated, implanted, or removed device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... action 0..1CodeableConceptKind of change to device
Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure.

.... manipulated 1..1Reference(Device)Device that was changed
... usedReference 0..*Reference(Device | Medication | Substance)Items used during procedure
... usedCode 0..*CodeableConceptCoded items used during the procedure
Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Procedure.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Procedure.statusrequiredEventStatus
Procedure.statusReasonexampleProcedureNotPerformedReason(SNOMED-CT)
Procedure.categoryexampleProcedureCategoryCodes(SNOMEDCT)
Procedure.codeextensibleUSCoreProcedureCodes
Procedure.performer.functionexampleProcedurePerformerRoleCodes
Procedure.reasonCodeexampleProcedureReasonCodes
Procedure.bodySiteexampleSNOMEDCTBodyStructures
Procedure.outcomeexampleProcedureOutcomeCodes(SNOMEDCT)
Procedure.complicationexampleCondition/Problem/DiagnosisCodes
Procedure.followUpexampleProcedureFollowUpCodes(SNOMEDCT)
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
Procedure.usedCodeexampleFHIRDeviceTypes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from USCoreProcedureProfile

Summary

Must-Support: 2 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron