STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) v1.6.0. The current version which supersedes this version is 7.0.2. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-procedure

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/qicore/StructureDefinition/qicore-procedure

This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure I0..*An action that is being or was performed on a patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
pro-1: Reason not performed is only permitted if notPerformed indicator is true
... 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... procedure-approachBodySite I0..*Reference(BodySite)Extension
URL: http://hl7.org/fhir/StructureDefinition/procedure-approachBodySite
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... procedure-incisionDateTime I0..1dateTimeExtension
URL: http://hl7.org/fhir/StructureDefinition/procedure-incisionDateTime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierExternal Identifiers for this procedure
... subject S1..1Reference(Profile qicore-patient | Group)Who the procedure was performed on
... status ?!S1..1codein-progress | aborted | completed | entered-in-error
Binding: ProcedureStatus (required)
... category ∑0..1CodeableConceptClassification of the procedure
Binding: Procedure Category Codes (SNOMED CT) (example)
... code S1..1CodeableConceptIdentification of the procedure
Binding: 7.org/fhir/daf/ValueSet/daf-procedure-type (preferred)
... notPerformed ?!∑0..1booleanTrue if procedure was not performed as scheduled
... reasonNotPerformed I0..*CodeableConceptReason procedure was not performed
Binding: Procedure Not Performed Reason (SNOMED-CT) (example)
... bodySite S0..*CodeableConceptTarget body sites
Binding: SNOMED CT Body Structures (example)
... reasonReference 0..*Reference(Condition)Condition that is the reason the procedure performed
... reasonCode S0..*CodeableConceptCoded reason procedure performed
Binding: Procedure Reason Codes (example)
... performer S0..*BackboneElementThe people who performed the procedure
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... actor 0..1Reference(Profile qicore-practitioner | Profile qicore-organization | Profile qicore-patient | Profile qicore-relatedperson)The reference to the practitioner
.... role ∑0..1CodeableConceptThe role the actor was in
Binding: Procedure Performer Role Codes (example)
... performed[x] S0..1dateTime, PeriodDate/Period the procedure was performed
... encounter S0..1Reference(Profile qicore-encounter)An interaction during which services are provided to the patient
... location 0..1Reference(Profile qicore-location)Details and position information for a physical place
... outcome ∑0..1CodeableConceptThe result of procedure
Binding: Procedure Outcome Codes (SNOMED CT) (example)
... report S0..*Reference(Profile qicore-diagnosticreport)A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... complication 0..*CodeableConceptComplication following the procedure
Binding: Condition/Problem/Diagnosis Codes (example)
... followUp 0..*CodeableConceptInstructions for follow up
Binding: Procedure Follow up Codes (SNOMED CT) (example)
... request 0..1Reference(CarePlan | DiagnosticRequest | ProcedureRequest | ReferralRequest)A request for this procedure
... notes 0..*AnnotationAdditional information about the procedure
... focalDevice 0..*BackboneElementDevice changed in procedure
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... action 0..1CodeableConceptKind of change to device
Binding: Procedure Device Action Codes (required)
.... manipulated 1..1Reference(Profile qicore-device)Item used in healthcare
... usedReference 0..*Reference(Device | Medication | Substance)Items used during procedure
... usedCode 0..*CodeableConceptCoded items used during the procedure
Binding: (unbound) (example)
... component 0..*Reference(MedicationAdministration | Procedure | Observation)Events related to the procedure

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure I0..*An action that is being or was performed on a patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
pro-1: Reason not performed is only permitted if notPerformed indicator is true
... 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... procedure-approachBodySite I0..*Reference(BodySite)Extension
URL: http://hl7.org/fhir/StructureDefinition/procedure-approachBodySite
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... procedure-incisionDateTime I0..1dateTimeExtension
URL: http://hl7.org/fhir/StructureDefinition/procedure-incisionDateTime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierExternal Identifiers for this procedure
... subject S1..1Reference(Profile qicore-patient | Group)Who the procedure was performed on
... status ?!S1..1codein-progress | aborted | completed | entered-in-error
Binding: ProcedureStatus (required)
... category ∑0..1CodeableConceptClassification of the procedure
Binding: Procedure Category Codes (SNOMED CT) (example)
... code S1..1CodeableConceptIdentification of the procedure
Binding: 7.org/fhir/daf/ValueSet/daf-procedure-type (preferred)
... notPerformed ?!∑0..1booleanTrue if procedure was not performed as scheduled
... reasonNotPerformed I0..*CodeableConceptReason procedure was not performed
Binding: Procedure Not Performed Reason (SNOMED-CT) (example)
... bodySite S0..*CodeableConceptTarget body sites
Binding: SNOMED CT Body Structures (example)
... reasonReference 0..*Reference(Condition)Condition that is the reason the procedure performed
... reasonCode S0..*CodeableConceptCoded reason procedure performed
Binding: Procedure Reason Codes (example)
... performer S0..*BackboneElementThe people who performed the procedure
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... actor 0..1Reference(Profile qicore-practitioner | Profile qicore-organization | Profile qicore-patient | Profile qicore-relatedperson)The reference to the practitioner
.... role ∑0..1CodeableConceptThe role the actor was in
Binding: Procedure Performer Role Codes (example)
... performed[x] S0..1dateTime, PeriodDate/Period the procedure was performed
... encounter S0..1Reference(Profile qicore-encounter)An interaction during which services are provided to the patient
... location 0..1Reference(Profile qicore-location)Details and position information for a physical place
... outcome ∑0..1CodeableConceptThe result of procedure
Binding: Procedure Outcome Codes (SNOMED CT) (example)
... report S0..*Reference(Profile qicore-diagnosticreport)A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... complication 0..*CodeableConceptComplication following the procedure
Binding: Condition/Problem/Diagnosis Codes (example)
... followUp 0..*CodeableConceptInstructions for follow up
Binding: Procedure Follow up Codes (SNOMED CT) (example)
... request 0..1Reference(CarePlan | DiagnosticRequest | ProcedureRequest | ReferralRequest)A request for this procedure
... notes 0..*AnnotationAdditional information about the procedure
... focalDevice 0..*BackboneElementDevice changed in procedure
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... action 0..1CodeableConceptKind of change to device
Binding: Procedure Device Action Codes (required)
.... manipulated 1..1Reference(Profile qicore-device)Item used in healthcare
... usedReference 0..*Reference(Device | Medication | Substance)Items used during procedure
... usedCode 0..*CodeableConceptCoded items used during the procedure
Binding: (unbound) (example)
... component 0..*Reference(MedicationAdministration | Procedure | Observation)Events related to the procedure

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Procedure.languageCommon LanguagesextensibleCommon Languages
Procedure.statusProcedureStatusrequiredProcedureStatus
Procedure.categoryProcedure Category Codes (SNOMED CT)exampleProcedure Category Codes (SNOMED CT)
Procedure.code?extpreferredhttp://hl7.org/fhir/daf/ValueSet/daf-procedure-type
Procedure.reasonNotPerformedProcedure Not Performed Reason (SNOMED-CT)exampleProcedure Not Performed Reason (SNOMED-CT)
Procedure.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
Procedure.reasonCodeProcedure Reason CodesexampleProcedure Reason Codes
Procedure.performer.roleProcedure Performer Role CodesexampleProcedure Performer Role Codes
Procedure.outcomeProcedure Outcome Codes (SNOMED CT)exampleProcedure Outcome Codes (SNOMED CT)
Procedure.complicationCondition/Problem/Diagnosis CodesexampleCondition/Problem/Diagnosis Codes
Procedure.followUpProcedure Follow up Codes (SNOMED CT)exampleProcedure Follow up Codes (SNOMED CT)
Procedure.focalDevice.actionProcedure Device Action CodesrequiredProcedure Device Action Codes
Procedure.usedCode?extexample

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1ProcedureIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4ProcedureIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3ProcedureIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
pro-1ProcedureReason not performed is only permitted if notPerformed indicator is true
XPath: not(exists(f:reasonNotPerformed)) or f:notPerformed/@value=true()
ele-1Procedure.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Procedure.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Procedure.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Procedure.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Procedure.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Procedure.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
.