This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions
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.
This structure is derived from Procedure
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Procedure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | I | 0..* | 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..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: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
procedure-approachBodySite | I | 0..* | 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 | I | 0..1 | dateTime | Extension 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..* | Extension | Extensions that cannot be ignored |
identifier | ∑ | 0..* | Identifier | External Identifiers for this procedure |
subject | S | 1..1 | Reference(Profile qicore-patient | Group) | Who the procedure was performed on |
status | ?!S | 1..1 | code | in-progress | aborted | completed | entered-in-error Binding: ProcedureStatus (required) |
category | ∑ | 0..1 | CodeableConcept | Classification of the procedure Binding: Procedure Category Codes (SNOMED CT) (example) |
code | S | 1..1 | CodeableConcept | Identification of the procedure Binding: 7.org/fhir/daf/ValueSet/daf-procedure-type (preferred) |
notPerformed | ?!∑ | 0..1 | boolean | True if procedure was not performed as scheduled |
reasonNotPerformed | I | 0..* | CodeableConcept | Reason procedure was not performed Binding: Procedure Not Performed Reason (SNOMED-CT) (example) |
bodySite | S | 0..* | CodeableConcept | Target body sites Binding: SNOMED CT Body Structures (example) |
reasonReference | 0..* | Reference(Condition) | Condition that is the reason the procedure performed | |
reasonCode | S | 0..* | CodeableConcept | Coded reason procedure performed Binding: Procedure Reason Codes (example) |
performer | S | 0..* | BackboneElement | The people who performed the procedure |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
actor | 0..1 | Reference(Profile qicore-practitioner | Profile qicore-organization | Profile qicore-patient | Profile qicore-relatedperson) | The reference to the practitioner | |
role | ∑ | 0..1 | CodeableConcept | The role the actor was in Binding: Procedure Performer Role Codes (example) |
performed[x] | S | 0..1 | dateTime, Period | Date/Period the procedure was performed |
encounter | S | 0..1 | Reference(Profile qicore-encounter) | An interaction during which services are provided to the patient |
location | 0..1 | Reference(Profile qicore-location) | Details and position information for a physical place | |
outcome | ∑ | 0..1 | CodeableConcept | The result of procedure Binding: Procedure Outcome Codes (SNOMED CT) (example) |
report | S | 0..* | Reference(Profile qicore-diagnosticreport) | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports |
complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/Diagnosis Codes (example) | |
followUp | 0..* | CodeableConcept | Instructions for follow up Binding: Procedure Follow up Codes (SNOMED CT) (example) | |
request | 0..1 | Reference(CarePlan | DiagnosticRequest | ProcedureRequest | ReferralRequest) | A request for this procedure | |
notes | 0..* | Annotation | Additional information about the procedure | |
focalDevice | 0..* | BackboneElement | Device changed in procedure | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
action | 0..1 | CodeableConcept | Kind of change to device Binding: Procedure Device Action Codes (required) | |
manipulated | 1..1 | Reference(Profile qicore-device) | Item used in healthcare | |
usedReference | 0..* | Reference(Device | Medication | Substance) | Items used during procedure | |
usedCode | 0..* | CodeableConcept | Coded items used during the procedure Binding: (unbound) (example) | |
component | 0..* | Reference(MedicationAdministration | Procedure | Observation) | Events related to the procedure | |
Documentation for this format |
yet to be done: Xml template
yet to be done: Json template
This structure is derived from StructureDefinition.
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from StructureDefinition.
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | I | 0..* | 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..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: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
procedure-approachBodySite | I | 0..* | 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 | I | 0..1 | dateTime | Extension 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..* | Extension | Extensions that cannot be ignored |
identifier | ∑ | 0..* | Identifier | External Identifiers for this procedure |
subject | S | 1..1 | Reference(Profile qicore-patient | Group) | Who the procedure was performed on |
status | ?!S | 1..1 | code | in-progress | aborted | completed | entered-in-error Binding: ProcedureStatus (required) |
category | ∑ | 0..1 | CodeableConcept | Classification of the procedure Binding: Procedure Category Codes (SNOMED CT) (example) |
code | S | 1..1 | CodeableConcept | Identification of the procedure Binding: 7.org/fhir/daf/ValueSet/daf-procedure-type (preferred) |
notPerformed | ?!∑ | 0..1 | boolean | True if procedure was not performed as scheduled |
reasonNotPerformed | I | 0..* | CodeableConcept | Reason procedure was not performed Binding: Procedure Not Performed Reason (SNOMED-CT) (example) |
bodySite | S | 0..* | CodeableConcept | Target body sites Binding: SNOMED CT Body Structures (example) |
reasonReference | 0..* | Reference(Condition) | Condition that is the reason the procedure performed | |
reasonCode | S | 0..* | CodeableConcept | Coded reason procedure performed Binding: Procedure Reason Codes (example) |
performer | S | 0..* | BackboneElement | The people who performed the procedure |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
actor | 0..1 | Reference(Profile qicore-practitioner | Profile qicore-organization | Profile qicore-patient | Profile qicore-relatedperson) | The reference to the practitioner | |
role | ∑ | 0..1 | CodeableConcept | The role the actor was in Binding: Procedure Performer Role Codes (example) |
performed[x] | S | 0..1 | dateTime, Period | Date/Period the procedure was performed |
encounter | S | 0..1 | Reference(Profile qicore-encounter) | An interaction during which services are provided to the patient |
location | 0..1 | Reference(Profile qicore-location) | Details and position information for a physical place | |
outcome | ∑ | 0..1 | CodeableConcept | The result of procedure Binding: Procedure Outcome Codes (SNOMED CT) (example) |
report | S | 0..* | Reference(Profile qicore-diagnosticreport) | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports |
complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/Diagnosis Codes (example) | |
followUp | 0..* | CodeableConcept | Instructions for follow up Binding: Procedure Follow up Codes (SNOMED CT) (example) | |
request | 0..1 | Reference(CarePlan | DiagnosticRequest | ProcedureRequest | ReferralRequest) | A request for this procedure | |
notes | 0..* | Annotation | Additional information about the procedure | |
focalDevice | 0..* | BackboneElement | Device changed in procedure | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
action | 0..1 | CodeableConcept | Kind of change to device Binding: Procedure Device Action Codes (required) | |
manipulated | 1..1 | Reference(Profile qicore-device) | Item used in healthcare | |
usedReference | 0..* | Reference(Device | Medication | Substance) | Items used during procedure | |
usedCode | 0..* | CodeableConcept | Coded items used during the procedure Binding: (unbound) (example) | |
component | 0..* | Reference(MedicationAdministration | Procedure | Observation) | Events related to the procedure | |
Documentation for this format |
XML Template
yet to be done: Xml template
JSON Template
yet to be done: Json template
Path | Name | Conformance | ValueSet |
Procedure.language | Common Languages | extensible | Common Languages |
Procedure.status | ProcedureStatus | required | ProcedureStatus |
Procedure.category | Procedure Category Codes (SNOMED CT) | example | Procedure Category Codes (SNOMED CT) |
Procedure.code | ?ext | preferred | http://hl7.org/fhir/daf/ValueSet/daf-procedure-type |
Procedure.reasonNotPerformed | Procedure Not Performed Reason (SNOMED-CT) | example | Procedure Not Performed Reason (SNOMED-CT) |
Procedure.bodySite | SNOMED CT Body Structures | example | SNOMED CT Body Structures |
Procedure.reasonCode | Procedure Reason Codes | example | Procedure Reason Codes |
Procedure.performer.role | Procedure Performer Role Codes | example | Procedure Performer Role Codes |
Procedure.outcome | Procedure Outcome Codes (SNOMED CT) | example | Procedure Outcome Codes (SNOMED CT) |
Procedure.complication | Condition/Problem/Diagnosis Codes | example | Condition/Problem/Diagnosis Codes |
Procedure.followUp | Procedure Follow up Codes (SNOMED CT) | example | Procedure Follow up Codes (SNOMED CT) |
Procedure.focalDevice.action | Procedure Device Action Codes | required | Procedure Device Action Codes |
Procedure.usedCode | ?ext | example |
Id | Path | Details | Requirements |
dom-2 | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
dom-1 | Procedure | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
dom-4 | Procedure | If 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-3 | Procedure | If 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-1 | Procedure | Reason not performed is only permitted if notPerformed indicator is true XPath: not(exists(f:reasonNotPerformed)) or f:notPerformed/@value=true() | |
ele-1 | Procedure.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Procedure.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Procedure.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Procedure.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Procedure.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Procedure.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) |