SDOH Clinical Care
2.0.0 - STU 2 US

This page is part of the SDOH Clinical Care for Multiple Domains (v2.0.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: SDOHCCProcedure - Detailed Descriptions

Draft as of 2020-12-14

Definitions for the SDOHCC-Procedure resource profile.

1. Procedure
Definition

For procedures that address SDOH conditions, SDOH observations, or SDOH goals.

The US Core Condition Profile is based upon the core FHIR Procedure Resource and created to meet the 2015 Edition Common Clinical Data Set 'Procedures' requirements.

Comments

Many of the SDOHCC profiles reference one another. One flow supported by this IG is that QuestionnaireResponses result in Observations that can be used as evidence for Conditions that can lead to Goals, ServiceRequests and Procedures. However, alternatives paths are also possible.

2. Procedure.extension
SlicingThis element introduces a set of slices on Procedure.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3. Procedure.extension:pertainsToGoal
SliceNamepertainsToGoal
Definition

Indicates that the resource is related to either the measurement, achievement or progress towards the referenced goal. For example, a Procedure to provide food vouchers pertainsToGoal of achieving food security.

Control0..?
TypeExtension(pertainsToGoal) (Extension Type: Reference(Goal)))
Must Supporttrue
Requirements

Indicates that the procedure is related to the referenced SDOHCC Goal.

4. Procedure.extension:pertainsToGoal.value[x]
Definition

Value of extension must reference a Goal resource.

Control0..?
TypeReference(SDOHCCGoal))
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Requirements

Indicates that the procedure is related to the referenced SDOHCC Goal.

5. Procedure.basedOn
Must Supporttrue
SlicingThis element introduces a set of slices on Procedure.basedOn. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
6. Procedure.basedOn:SupportedBasedOn
SliceNameSupportedBasedOn
Definition

A reference to an SDOHCC service request that contains details of the request for this procedure.

Control0..?
TypeReference(SDOHCCServiceRequest))
Must Supporttrue
Requirements

When a procedure is based on an SDOH ServiceRequest, Procedure.basedOn should reference instances that comply with the SDOHCC ServiceRequest profile. However, references to other instance types are also possible.

7. Procedure.category
Definition

A code that classifies the procedure for searching, sorting and display purposes (e.g. "Social service procedure").

A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").

8. Procedure.category.coding
Control0..?
Must Supporttrue
SlicingThis element introduces a set of slices on Procedure.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
9. Procedure.category.coding:SDOH
SliceNameSDOH
Definition

An SDOH category assigned to the procedure.

Control0..1
BindingThe codes SHALL be taken from SDOHCC ValueSet SDOH Category Codes for high-level SDOH categories
Must Supporttrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.
Codes from this value set can be used to assign an SDOH category (e.g., food-insecurity, transportation-insecurity, etc.) to a procedure. It is recommended that SDOH category codes be used to facilitate searching for SDOH procedures that address SDOH conditions, observations, service requests, or goals.

10. Procedure.code
Definition

The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded.

The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").

Comments

As the Gravity Project continues to refine content for the SDOH categories (e.g., food, housing, transportation, etc.), this value set will be refined to codes that pertain to SDOH categories. For further guidance on external value sets vetted by the Gravity Project see: SDOH terminology guidance

11. Procedure.performed[x]
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

NOTE: dateTime should be Must Support, but currenlty tooling does not support this.

12. Procedure.reasonCode
Comments

Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

Information represented by Procedure.reasonCode may overlap significantly with information represented by Procedure.reasonReference. Multiple approaches to representing the same information may negatively impact interoperability. Therefore, where similar information could be provided by either Procedure.reasonCode or Procedure.reasonReference, it is recommended that Procedure.reasonReference be used to provide a reason for why a procedure was performed.

As the Gravity Project continues to refine content for the SDOH categories (e.g., food, housing, transportation, etc.), this value set may be refined to codes that pertain to SDOH categories.

Use Procedure.reasonCode when a code sufficiently describes the reason. Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

13. Procedure.reasonReference
Comments

Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

Additionally, see Comments for reasonCode.

It is possible for a procedure to be a reason (such as C-Section) for another procedure (such as an epidural). Other examples include endoscopy for dilatation and biopsy (a combination of diagnostic and therapeutic use). Use Procedure.reasonCode when a code sufficiently describes the reason. Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

SlicingThis element introduces a set of slices on Procedure.reasonReference. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
14. Procedure.reasonReference:SupportedReasonReference
SliceNameSupportedReasonReference
Control0..?
TypeReference(SDOHCCCondition|SDOHCCObservationScreeningResponse|SDOHCCObservationAssessment))
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Requirements

When a procedure is justified by one or more SDOH conditions or observations, Procedure.reasonReference should reference instances that comply with the SDOHCC Condition profile, or one of the SDOHCC Observation profiles. However, references to other instance types are also possible.

Comments

Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

1. Procedure
Definition

For procedures that address SDOH conditions, SDOH observations, or SDOH goals.

An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.

Control0..*
Comments

Many of the SDOHCC profiles reference one another. One flow supported by this IG is that QuestionnaireResponses result in Observations that can be used as evidence for Conditions that can lead to Goals, ServiceRequests and Procedures. However, alternatives paths are also possible.

InvariantsDefined on this element
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: 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().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-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. Procedure.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. Procedure.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Procedure.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Procedure.extension:pertainsToGoal
SliceNamepertainsToGoal
Definition

Indicates that the resource is related to either the measurement, achievement or progress towards the referenced goal. For example, a Procedure to provide food vouchers pertainsToGoal of achieving food security.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(pertainsToGoal) (Extension Type: Reference(Goal)))
Must Supporttrue
Requirements

Indicates that the procedure is related to the referenced SDOHCC Goal.

Comments

This extension is limited to subject-specific activity-related resources (events & intents). I.e. This can't be put on Goal or Patient. This association isn't for the purpose of goal management, but for things such as noting that a particular observation result, prescription or other activity is pertinent to the achievement (or possibly non-achievement) of the referenced goal.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
5. Procedure.extension:pertainsToGoal.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..0*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Procedure.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. Procedure.extension:pertainsToGoal.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
7. Procedure.extension:pertainsToGoal.value[x]
Definition

Value of extension must reference a Goal resource.

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control10..1
TypeChoice of: Reference(SDOHCCGoal)), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Requirements

Indicates that the procedure is related to the referenced SDOHCC Goal.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Procedure.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. Procedure.basedOn
Definition

A reference to a resource that contains details of the request for this procedure.

Control0..*
TypeReference(CarePlan|ServiceRequest))
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Alternate Namesfulfills
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Procedure.basedOn. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
10. Procedure.basedOn:SupportedBasedOn
SliceNameSupportedBasedOn
Definition

A reference to an SDOHCC service request that contains details of the request for this procedure.

A reference to a resource that contains details of the request for this procedure.

Control0..*
TypeReference(SDOHCCServiceRequest|CarePlan|ServiceRequest))
Must Supporttrue
Requirements

When a procedure is based on an SDOH ServiceRequest, Procedure.basedOn should reference instances that comply with the SDOHCC ServiceRequest profile. However, references to other instance types are also possible.

Alternate Namesfulfills
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Procedure.status
Definition

A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.

Control1..1
BindingThe codes SHALL be taken from EventStatus
Typecode
Is Modifiertrue
Must Supporttrue
Comments

The "unknown" code is not to be used to convey other statuses. The "unknown" code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the procedure.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Procedure.category
Definition

A code that classifies the procedure for searching, sorting and display purposes (e.g. "Social service procedure").

A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").

Control0..1
BindingFor example codes, see ProcedureCategoryCodes(SNOMEDCT)

A code that classifies a procedure for searching, sorting and display purposes.

TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Procedure.category.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Must Supporttrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Procedure.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
14. Procedure.category.coding:SDOH
SliceNameSDOH
Definition

An SDOH category assigned to the procedure.

A reference to a code defined by a terminology system.

Control0..1*
BindingThe codes SHALL be taken from SDOHCC ValueSet SDOH CategoryFor codes, see (unbound) Codes for high-level SDOH categories
TypeCoding
Must Supporttrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.
Codes from this value set can be used to assign an SDOH category (e.g., food-insecurity, transportation-insecurity, etc.) to a procedure. It is recommended that SDOH category codes be used to facilitate searching for SDOH procedures that address SDOH conditions, observations, service requests, or goals.

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Procedure.code
Definition

The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded.

The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").

Control10..1
BindingThe codes SHALL be taken from US Core Procedure CodesFor example codes, see ProcedureCodes(SNOMEDCT)
TypeCodeableConcept
Must Supporttrue
Requirements

0..1 to account for primarily narrative only resources.

Alternate Namestype
Comments

As the Gravity Project continues to refine content for the SDOH categories (e.g., food, housing, transportation, etc.), this value set will be refined to codes that pertain to SDOH categories. For further guidance on external value sets vetted by the Gravity Project see: SDOH terminology guidance

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Procedure.subject
Definition

The person, animal or group on which the procedure was performed.

Control1..1
TypeReference(USCorePatientProfile|Patient|Group))
Must Supporttrue
Alternate Namespatient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Procedure.performed[x]
Definition

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

Control10..1
TypeChoice of: dateTime, Period, string, Range, Age
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Requirements

NOTE: dateTime should be Must Support, but currenlty tooling does not support this.

Comments

Age is generally used when the patient reports an age at which the procedure was performed. Range is generally used when the patient reports an age range when the procedure was performed, such as sometime between 20-25 years old. dateTime supports a range of precision due to some procedures being reported as past procedures that might not have millisecond precision while other procedures performed and documented during the encounter might have more precise UTC timestamps with timezone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Procedure.reasonCode
Definition

The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.

Control0..*
BindingFor example codes, see ProcedureReasonCodes

A code that identifies the reason a procedure is required.

TypeCodeableConcept
Comments

Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

Information represented by Procedure.reasonCode may overlap significantly with information represented by Procedure.reasonReference. Multiple approaches to representing the same information may negatively impact interoperability. Therefore, where similar information could be provided by either Procedure.reasonCode or Procedure.reasonReference, it is recommended that Procedure.reasonReference be used to provide a reason for why a procedure was performed.

As the Gravity Project continues to refine content for the SDOH categories (e.g., food, housing, transportation, etc.), this value set may be refined to codes that pertain to SDOH categories.

Use Procedure.reasonCode when a code sufficiently describes the reason. Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Procedure.reasonReference
Definition

The justification of why the procedure was performed.

Control0..*
TypeReference(Condition|Observation|Procedure|DiagnosticReport|DocumentReference))
Comments

Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

Additionally, see Comments for reasonCode.

It is possible for a procedure to be a reason (such as C-Section) for another procedure (such as an epidural). Other examples include endoscopy for dilatation and biopsy (a combination of diagnostic and therapeutic use). Use Procedure.reasonCode when a code sufficiently describes the reason. Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Procedure.reasonReference. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
20. Procedure.reasonReference:SupportedReasonReference
SliceNameSupportedReasonReference
Definition

The justification of why the procedure was performed.

Control0..*
TypeReference(SDOHCCCondition|SDOHCCObservationScreeningResponse|SDOHCCObservationAssessment|Condition|Observation|Procedure|DiagnosticReport|DocumentReference))
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Requirements

When a procedure is justified by one or more SDOH conditions or observations, Procedure.reasonReference should reference instances that comply with the SDOHCC Condition profile, or one of the SDOHCC Observation profiles. However, references to other instance types are also possible.

Comments

Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

It is possible for a procedure to be a reason (such as C-Section) for another procedure (such as an epidural). Other examples include endoscopy for dilatation and biopsy (a combination of diagnostic and therapeutic use). Use Procedure.reasonCode when a code sufficiently describes the reason. Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1. Procedure
Definition

For procedures that address SDOH conditions, SDOH observations, or SDOH goals.

Control0..*
Comments

Many of the SDOHCC profiles reference one another. One flow supported by this IG is that QuestionnaireResponses result in Observations that can be used as evidence for Conditions that can lead to Goals, ServiceRequests and Procedures. However, alternatives paths are also possible.

2. Procedure.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. Procedure.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1
TypeMeta
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Procedure.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Procedure.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Procedure.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1
TypeNarrative
Alternate Namesnarrativehtmlxhtmldisplay
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Procedure.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resourcesanonymous resourcescontained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

8. Procedure.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Procedure.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Procedure.extension:pertainsToGoal
SliceNamepertainsToGoal
Definition

Indicates that the resource is related to either the measurement, achievement or progress towards the referenced goal. For example, a Procedure to provide food vouchers pertainsToGoal of achieving food security.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(pertainsToGoal) (Extension Type: Reference(Goal)))
Must Supporttrue
Requirements

Indicates that the procedure is related to the referenced SDOHCC Goal.

Comments

This extension is limited to subject-specific activity-related resources (events & intents). I.e. This can't be put on Goal or Patient. This association isn't for the purpose of goal management, but for things such as noting that a particular observation result, prescription or other activity is pertinent to the achievement (or possibly non-achievement) of the referenced goal.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Procedure.extension:pertainsToGoal.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
11. Procedure.extension:pertainsToGoal.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Procedure.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
12. Procedure.extension:pertainsToGoal.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
13. Procedure.extension:pertainsToGoal.value[x]
Definition

Value of extension must reference a Goal resource.

Control1..1
TypeReference(SDOHCCGoal))
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Requirements

Indicates that the procedure is related to the referenced SDOHCC Goal.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Procedure.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. Procedure.identifier
Definition

Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Allows identification of the procedure as it is known by various participating systems and in a way that remains consistent across servers.

Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and Person resource instances might share the same social insurance number.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Procedure.instantiatesCanonical
Definition

The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

Control0..*
Typecanonical(PlanDefinitionActivityDefinitionMeasureOperationDefinitionQuestionnaire))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Procedure.instantiatesUri
Definition

The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

Control0..*
Typeuri
Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Procedure.basedOn
Definition

A reference to a resource that contains details of the request for this procedure.

Control0..*
TypeReference(CarePlanServiceRequest))
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Alternate Namesfulfills
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Procedure.basedOn. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
19. Procedure.basedOn:SupportedBasedOn
SliceNameSupportedBasedOn
Definition

A reference to an SDOHCC service request that contains details of the request for this procedure.

Control0..*
TypeReference(SDOHCCServiceRequest))
Must Supporttrue
Requirements

When a procedure is based on an SDOH ServiceRequest, Procedure.basedOn should reference instances that comply with the SDOHCC ServiceRequest profile. However, references to other instance types are also possible.

Alternate Namesfulfills
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Procedure.partOf
Definition

A larger event of which this particular procedure is a component or step.

Control0..*
TypeReference(ProcedureObservationMedicationAdministration))
Alternate Namescontainer
Comments

The MedicationAdministration resource has a partOf reference to Procedure, but this is not a circular reference. For example, the anesthesia MedicationAdministration is part of the surgical Procedure (MedicationAdministration.partOf = Procedure). For example, the procedure to insert the IV port for an IV medication administration is part of the medication administration (Procedure.partOf = MedicationAdministration).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Procedure.status
Definition

A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.

Control1..1
BindingThe codes SHALL be taken from EventStatus
Typecode
Is Modifiertrue
Must Supporttrue
Comments

The "unknown" code is not to be used to convey other statuses. The "unknown" code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the procedure.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Procedure.statusReason
Definition

Captures the reason for the current state of the procedure.

Control0..1
BindingFor example codes, see ProcedureNotPerformedReason(SNOMED-CT) A code that identifies the reason a procedure was not performed
TypeCodeableConcept
Alternate NamesSuspended ReasonCancelled Reason
Comments

This is generally only used for "exception" statuses such as "not-done", "suspended" or "aborted". The reason for performing the event at all is captured in reasonCode, not here.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Procedure.category
Definition

A code that classifies the procedure for searching, sorting and display purposes (e.g. "Social service procedure").

Control0..1
BindingFor example codes, see ProcedureCategoryCodes(SNOMEDCT) A code that classifies a procedure for searching, sorting and display purposes
TypeCodeableConcept
24. Procedure.category.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
25. Procedure.category.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Procedure.category.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
26. Procedure.category.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Must Supporttrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Procedure.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
27. Procedure.category.coding:SDOH
SliceNameSDOH
Definition

An SDOH category assigned to the procedure.

Control0..1
BindingThe codes SHALL be taken from SDOHCC ValueSet SDOH Category Codes for high-level SDOH categories
TypeCoding
Must Supporttrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.
Codes from this value set can be used to assign an SDOH category (e.g., food-insecurity, transportation-insecurity, etc.) to a procedure. It is recommended that SDOH category codes be used to facilitate searching for SDOH procedures that address SDOH conditions, observations, service requests, or goals.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Procedure.category.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Procedure.code
Definition

The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded.

Control1..1
BindingThe codes SHALL be taken from US Core Procedure Codes
TypeCodeableConcept
Must Supporttrue
Requirements

0..1 to account for primarily narrative only resources.

Alternate Namestype
Comments

As the Gravity Project continues to refine content for the SDOH categories (e.g., food, housing, transportation, etc.), this value set will be refined to codes that pertain to SDOH categories. For further guidance on external value sets vetted by the Gravity Project see: SDOH terminology guidance

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Procedure.subject
Definition

The person, animal or group on which the procedure was performed.

Control1..1
TypeReference(USCorePatientProfile))
Must Supporttrue
Alternate Namespatient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. Procedure.encounter
Definition

The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.

Control0..1
TypeReference(Encounter))
Comments

This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Procedure.performed[x]
Definition

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

Control1..1
TypeChoice of: dateTime, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Requirements

NOTE: dateTime should be Must Support, but currenlty tooling does not support this.

Comments

Age is generally used when the patient reports an age at which the procedure was performed. Range is generally used when the patient reports an age range when the procedure was performed, such as sometime between 20-25 years old. dateTime supports a range of precision due to some procedures being reported as past procedures that might not have millisecond precision while other procedures performed and documented during the encounter might have more precise UTC timestamps with timezone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. Procedure.recorder
Definition

Individual who recorded the record and takes responsibility for its content.

Control0..1
TypeReference(PatientRelatedPersonPractitionerPractitionerRole))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. Procedure.asserter
Definition

Individual who is making the procedure statement.

Control0..1
TypeReference(PatientRelatedPersonPractitionerPractitionerRole))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Procedure.performer
Definition

Limited to "real" people rather than equipment.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Procedure.performer.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
37. Procedure.performer.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
38. Procedure.performer.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensionsuser contentmodifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
39. Procedure.performer.function
Definition

Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.

Control0..1
BindingFor example codes, see ProcedurePerformerRoleCodes A code that identifies the role of a performer of the procedure
TypeCodeableConcept
Requirements

Allows disambiguation of the types of involvement of different performers.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Procedure.performer.actor
Definition

The practitioner who was involved in the procedure.

Control1..1
TypeReference(PractitionerPractitionerRoleOrganizationPatientRelatedPersonDevice))
Requirements

A reference to Device supports use cases, such as pacemakers.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. Procedure.performer.onBehalfOf
Definition

The organization the device or practitioner was acting on behalf of.

Control0..1
TypeReference(Organization))
Requirements

Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when performing the action.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. Procedure.location
Definition

The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.

Control0..1
TypeReference(Location))
Requirements

Ties a procedure to where the records are likely kept.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. Procedure.reasonCode
Definition

The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.

Control0..*
BindingFor example codes, see ProcedureReasonCodes A code that identifies the reason a procedure is required
TypeCodeableConcept
Comments

Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

Information represented by Procedure.reasonCode may overlap significantly with information represented by Procedure.reasonReference. Multiple approaches to representing the same information may negatively impact interoperability. Therefore, where similar information could be provided by either Procedure.reasonCode or Procedure.reasonReference, it is recommended that Procedure.reasonReference be used to provide a reason for why a procedure was performed.

As the Gravity Project continues to refine content for the SDOH categories (e.g., food, housing, transportation, etc.), this value set may be refined to codes that pertain to SDOH categories.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Procedure.reasonReference
Definition

The justification of why the procedure was performed.

Control0..*
TypeReference(ConditionObservationProcedureDiagnosticReportDocumentReference))
Comments

Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

Additionally, see Comments for reasonCode.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Procedure.reasonReference. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
45. Procedure.reasonReference:SupportedReasonReference
SliceNameSupportedReasonReference
Definition

The justification of why the procedure was performed.

Control0..*
TypeReference(SDOHCCConditionSDOHCCObservationScreeningResponseSDOHCCObservationAssessment))
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Requirements

When a procedure is justified by one or more SDOH conditions or observations, Procedure.reasonReference should reference instances that comply with the SDOHCC Condition profile, or one of the SDOHCC Observation profiles. However, references to other instance types are also possible.

Comments

Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. Procedure.bodySite
Definition

Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.

Control0..*
BindingFor example codes, see SNOMEDCTBodyStructures Codes describing anatomical locations. May include laterality
TypeCodeableConcept
Comments

If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension procedure-targetbodystructure.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. Procedure.outcome
Definition

The outcome of the procedure - did it resolve the reasons for the procedure being performed?

Control0..1
BindingFor example codes, see ProcedureOutcomeCodes(SNOMEDCT) An outcome of a procedure - whether it was resolved or otherwise
TypeCodeableConcept
Comments

If outcome contains narrative text only, it can be captured using the CodeableConcept.text.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. Procedure.report
Definition

This could be a histology result, pathology report, surgical report, etc.

Control0..*
TypeReference(DiagnosticReportDocumentReferenceComposition))
Comments

There could potentially be multiple reports - e.g. if this was a procedure which took multiple biopsies resulting in a number of anatomical pathology reports.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. Procedure.complication
Definition

Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.

Control0..*
BindingFor example codes, see Condition/Problem/DiagnosisCodes Codes describing complications that resulted from a procedure
TypeCodeableConcept
Comments

If complications are only expressed by the narrative text, they can be captured using the CodeableConcept.text.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. Procedure.complicationDetail
Definition

Any complications that occurred during the procedure, or in the immediate post-performance period.

Control0..*
TypeReference(Condition))
Requirements

This is used to document a condition that is a result of the procedure, not the condition that was the reason for the procedure.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. Procedure.followUp
Definition

If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.

Control0..*
BindingFor example codes, see ProcedureFollowUpCodes(SNOMEDCT) Specific follow up required for a procedure e.g. removal of sutures
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. Procedure.note
Definition

Any other notes and comments about the procedure.

Control0..*
TypeAnnotation
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. Procedure.focalDevice
Definition

A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Procedure.focalDevice.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
55. Procedure.focalDevice.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
56. Procedure.focalDevice.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensionsuser contentmodifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
57. Procedure.focalDevice.action
Definition

The kind of change that happened to the device during the procedure.

Control0..1
BindingThe codes SHOULD be taken from ProcedureDeviceActionCodes A kind of change that happened to the device during the procedure
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. Procedure.focalDevice.manipulated
Definition

The device that was manipulated (changed) during the procedure.

Control1..1
TypeReference(Device))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. Procedure.usedReference
Definition

Identifies medications, devices and any other substance used as part of the procedure.

Control0..*
TypeReference(DeviceMedicationSubstance))
Requirements

Used for tracking contamination, etc.

Comments

For devices actually implanted or removed, use Procedure.device.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. Procedure.usedCode
Definition

Identifies coded items that were used as part of the procedure.

Control0..*
BindingFor example codes, see FHIRDeviceTypes Codes describing items used during a procedure
TypeCodeableConcept
Comments

For devices actually implanted or removed, use Procedure.device.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))