QI-Core Implementation Guide
6.0.0-ballot - ballot United States of America flag

This page is part of the Quality Improvement Core Framework (v6.0.0-ballot: STU6 (v6.0.0) Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: QICore Procedure

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-procedure Version: 6.0.0-ballot
Active as of 2018-08-22 Computable Name: QICoreProcedure

Profile of Procedure for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

Usage

To create an expression specifically requesting information that a procedure intentionally did not occur for a medical, patient or system reason, use the profile QICore-Procedurenotdone.

The following example illustrates the use of the Procedure profile:

define "Application of Intermittent Pneumatic Compression Devices":
  ["Procedure": "Application of Intermittent Pneumatic Compression Devices (IPC)"] DeviceApplied
    where DeviceApplied.status = 'completed'

See the patterns page for implementation and usage patterns.

Examples

Appendectomy Example

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
... implicitRules S0..1uriA set of rules under which this content was created
... recorded S1..1dateTimeWhen the procedure was first captured in the subject's record
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded
... status S1..1codepreparation | in-progress | ​on-hold​ | stopped​ | completed | entered-in-error​ | unknown​
Binding: Non-Negative Event Status (required)
... performer
.... actor 1..1Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore RelatedPerson)The reference to the practitioner
... reasonCode S0..*CodeableConceptCoded reason procedure performed
Binding: ProcedureReasonCodes (preferred): A code that identifies the reason a procedure is required.

... reasonReference S0..*Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns | QICore DiagnosticReport Profile for Report and Note Exchange | US Core DocumentReference Profile)The justification that the procedure was performed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Procedure.statusrequiredNonNegativeEventStatus
Procedure.reasonCodepreferredProcedureReasonCodes
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure C0..*USCoreProcedureProfileAn action that is being or was performed on a patient
... implicitRules ?!SΣ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... recorded S1..1dateTimeWhen the procedure was first captured in the subject's record
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded
... status ?!SΣC1..1codepreparation | in-progress | ​on-hold​ | stopped​ | completed | entered-in-error​ | unknown​
Binding: Non-Negative Event Status (required)
... code SΣ1..1CodeableConcept(USCDI) Identification of the procedure
Binding: US Core Procedure Codes (extensible): Codes describing the type of Procedure

... subject SΣ1..1Reference(QICore Patient)(USCDI) Who the procedure was performed on
... performed[x] SΣC0..1(USCDI) When the procedure was performed
.... performedDateTimedateTime
... reasonCode SΣ0..*CodeableConceptCoded reason procedure performed
Binding: ProcedureReasonCodes (preferred): A code that identifies the reason a procedure is required.


... reasonReference SΣ0..*Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns | QICore DiagnosticReport Profile for Report and Note Exchange | US Core DocumentReference Profile)The justification that the procedure was performed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Procedure.statusrequiredNonNegativeEventStatus
Procedure.codeextensibleUSCoreProcedureCodes
Procedure.reasonCodepreferredProcedureReasonCodes

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 ?!SΣ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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... recorded S1..1dateTimeWhen the procedure was first captured in the subject's record
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded
... 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..1codepreparation | in-progress | ​on-hold​ | stopped​ | completed | entered-in-error​ | unknown​
Binding: Non-Negative Event Status (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..1CodeableConcept(USCDI) Identification of the procedure
Binding: US Core Procedure Codes (extensible): Codes describing the type of Procedure

... subject SΣ1..1Reference(QICore Patient)(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(QICore Practitioner | QICore Organization | QICore Patient | QICore RelatedPerson)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 SΣ0..*CodeableConceptCoded reason procedure performed
Binding: ProcedureReasonCodes (preferred): A code that identifies the reason a procedure is required.


... reasonReference SΣ0..*Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns | QICore DiagnosticReport Profile for Report and Note Exchange | US Core DocumentReference Profile)The justification that the procedure 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.statusrequiredNonNegativeEventStatus
Procedure.statusReasonexampleProcedureNotPerformedReason(SNOMED-CT)
Procedure.categoryexampleProcedureCategoryCodes(SNOMEDCT)
Procedure.codeextensibleUSCoreProcedureCodes
Procedure.performer.functionexampleProcedurePerformerRoleCodes
Procedure.reasonCodepreferredProcedureReasonCodes
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()

Differential View

This structure is derived from USCoreProcedureProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*USCoreProcedureProfileAn action that is being or was performed on a patient
... implicitRules S0..1uriA set of rules under which this content was created
... recorded S1..1dateTimeWhen the procedure was first captured in the subject's record
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded
... status S1..1codepreparation | in-progress | ​on-hold​ | stopped​ | completed | entered-in-error​ | unknown​
Binding: Non-Negative Event Status (required)
... performer
.... actor 1..1Reference(QICore Practitioner | QICore Organization | QICore Patient | QICore RelatedPerson)The reference to the practitioner
... reasonCode S0..*CodeableConceptCoded reason procedure performed
Binding: ProcedureReasonCodes (preferred): A code that identifies the reason a procedure is required.

... reasonReference S0..*Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns | QICore DiagnosticReport Profile for Report and Note Exchange | US Core DocumentReference Profile)The justification that the procedure was performed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Procedure.statusrequiredNonNegativeEventStatus
Procedure.reasonCodepreferredProcedureReasonCodes

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure C0..*USCoreProcedureProfileAn action that is being or was performed on a patient
... implicitRules ?!SΣ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... recorded S1..1dateTimeWhen the procedure was first captured in the subject's record
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded
... status ?!SΣC1..1codepreparation | in-progress | ​on-hold​ | stopped​ | completed | entered-in-error​ | unknown​
Binding: Non-Negative Event Status (required)
... code SΣ1..1CodeableConcept(USCDI) Identification of the procedure
Binding: US Core Procedure Codes (extensible): Codes describing the type of Procedure

... subject SΣ1..1Reference(QICore Patient)(USCDI) Who the procedure was performed on
... performed[x] SΣC0..1(USCDI) When the procedure was performed
.... performedDateTimedateTime
... reasonCode SΣ0..*CodeableConceptCoded reason procedure performed
Binding: ProcedureReasonCodes (preferred): A code that identifies the reason a procedure is required.


... reasonReference SΣ0..*Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns | QICore DiagnosticReport Profile for Report and Note Exchange | US Core DocumentReference Profile)The justification that the procedure was performed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Procedure.statusrequiredNonNegativeEventStatus
Procedure.codeextensibleUSCoreProcedureCodes
Procedure.reasonCodepreferredProcedureReasonCodes

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 ?!SΣ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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... recorded S1..1dateTimeWhen the procedure was first captured in the subject's record
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded
... 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..1codepreparation | in-progress | ​on-hold​ | stopped​ | completed | entered-in-error​ | unknown​
Binding: Non-Negative Event Status (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..1CodeableConcept(USCDI) Identification of the procedure
Binding: US Core Procedure Codes (extensible): Codes describing the type of Procedure

... subject SΣ1..1Reference(QICore Patient)(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(QICore Practitioner | QICore Organization | QICore Patient | QICore RelatedPerson)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 SΣ0..*CodeableConceptCoded reason procedure performed
Binding: ProcedureReasonCodes (preferred): A code that identifies the reason a procedure is required.


... reasonReference SΣ0..*Reference(QICore Condition Encounter Diagnosis | QICore Condition Problems Health Concerns | QICore DiagnosticReport Profile for Report and Note Exchange | US Core DocumentReference Profile)The justification that the procedure 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.statusrequiredNonNegativeEventStatus
Procedure.statusReasonexampleProcedureNotPerformedReason(SNOMED-CT)
Procedure.categoryexampleProcedureCategoryCodes(SNOMEDCT)
Procedure.codeextensibleUSCoreProcedureCodes
Procedure.performer.functionexampleProcedurePerformerRoleCodes
Procedure.reasonCodepreferredProcedureReasonCodes
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()

 

Other representations of profile: CSV, Excel, Schematron