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
Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Procedure | Version: 2.0.0 | |||
Draft as of 2020-12-14 | Computable Name: SDOHCCProcedure |
Profile for interventions that address Social Determinants of Health.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreProcedureProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | 0..* | USCoreProcedureProfile | An action that addresses an SDOH condition, observation, or goal. | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
value[x] | S | 1..1 | Reference(SDOHCC Goal) | Value of extension |
Slices for basedOn | S | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure Slice: Unordered, Open by profile:resolve() |
basedOn:SupportedBasedOn | S | 0..* | Reference(SDOHCC ServiceRequest) | An SDOH service request for this procedure |
category | 0..1 | CodeableConcept | Classification of the procedure | |
Slices for coding | S | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this |
coding:SDOH | S | 0..1 | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
code | 1..1 | CodeableConcept | Procedure codes from SNOMED CT, CPT, HCPCS II, ICD-10PC, or CDT Binding: US Core Procedure Codes (required) | |
performed[x] | 1..1 | dateTime, Period | When the procedure was performed | |
reasonCode | 0..* | CodeableConcept | Coded reason procedure performed | |
Slices for reasonReference | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed Slice: Unordered, Open by profile:resolve() | |
reasonReference:SupportedReasonReference | S | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | The justification that the procedure was performed |
Documentation for this format |
Path | Conformance | ValueSet |
Procedure.category.coding:SDOH | required | SDOHCCValueSetSDOHCategory |
Procedure.code | required | USCoreProcedureCodes |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | 0..* | USCoreProcedureProfile | An action that addresses an SDOH condition, observation, or goal. | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal" | |
value[x] | S | 1..1 | Reference(SDOHCC Goal) | Value of extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for basedOn | SΣ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure Slice: Unordered, Open by profile:resolve() |
basedOn:SupportedBasedOn | SΣ | 0..* | Reference(SDOHCC ServiceRequest) | An SDOH service request for this procedure |
status | ?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) |
category | Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. |
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this |
coding:SDOH | SΣ | 0..1 | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
code | SΣ | 1..1 | CodeableConcept | Procedure codes from SNOMED CT, CPT, HCPCS II, ICD-10PC, or CDT Binding: US Core Procedure Codes (required) |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who the procedure was performed on |
performed[x] | SΣ | 1..1 | When the procedure was performed | |
performedDateTime | dateTime | |||
performedPeriod | Period | |||
reasonCode | Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. |
Slices for reasonReference | Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed Slice: Unordered, Open by profile:resolve() |
reasonReference:SupportedReasonReference | SΣ | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | The justification that the procedure was performed |
Documentation for this format |
Path | Conformance | ValueSet |
Procedure.status | required | EventStatus |
Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT) |
Procedure.category.coding:SDOH | required | SDOHCCValueSetSDOHCategory |
Procedure.code | required | USCoreProcedureCodes |
Procedure.reasonCode | example | ProcedureReasonCodes |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Procedure | 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 | error | Procedure | 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 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Procedure | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Procedure | 0..* | USCoreProcedureProfile | An action that addresses an SDOH condition, observation, or goal. | |||||
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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal" | |||||
value[x] | S | 1..1 | Reference(SDOHCC Goal) | Value of extension | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Identifiers for this procedure | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
Slices for basedOn | SΣ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure Slice: Unordered, Open by profile:resolve() | ||||
basedOn:SupportedBasedOn | SΣ | 0..* | Reference(SDOHCC ServiceRequest) | An SDOH service request for this procedure | ||||
partOf | Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) | ||||
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||
category | Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
coding:SDOH | SΣ | 0..1 | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
code | SΣ | 1..1 | CodeableConcept | Procedure codes from SNOMED CT, CPT, HCPCS II, ICD-10PC, or CDT Binding: US Core Procedure Codes (required) | ||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who the procedure was performed on | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
performed[x] | SΣ | 1..1 | When the procedure was performed | |||||
performedDateTime | dateTime | |||||||
performedPeriod | Period | |||||||
recorder | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||
performer | Σ | 0..* | BackboneElement | The people who performed the procedure | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner | ||||
onBehalfOf | 0..1 | Reference(Organization) | Organization the device or practitioner was acting for | |||||
location | Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||
reasonCode | Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. | ||||
Slices for reasonReference | Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed Slice: Unordered, Open by profile:resolve() | ||||
reasonReference:SupportedReasonReference | SΣ | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | The justification that the procedure was performed | ||||
bodySite | Σ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
outcome | Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||
report | 0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||
complicationDetail | 0..* | Reference(Condition) | A condition that is a result of the procedure | |||||
followUp | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||
note | 0..* | Annotation | Additional information about the procedure | |||||
focalDevice | 0..* | BackboneElement | Manipulated, implanted, or removed device | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
action | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||
manipulated | 1..1 | Reference(Device) | Device that was changed | |||||
usedReference | 0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||
usedCode | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Procedure.language | preferred | CommonLanguages
| ||||
Procedure.status | required | EventStatus | ||||
Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT) | ||||
Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT) | ||||
Procedure.category.coding:SDOH | required | SDOHCCValueSetSDOHCategory | ||||
Procedure.code | required | USCoreProcedureCodes | ||||
Procedure.performer.function | example | ProcedurePerformerRoleCodes | ||||
Procedure.reasonCode | example | ProcedureReasonCodes | ||||
Procedure.bodySite | example | SNOMEDCTBodyStructures | ||||
Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT) | ||||
Procedure.complication | example | Condition/Problem/DiagnosisCodes | ||||
Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT) | ||||
Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodes | ||||
Procedure.usedCode | example | FHIRDeviceTypes |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreProcedureProfile
Summary
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USCoreProcedureProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | 0..* | USCoreProcedureProfile | An action that addresses an SDOH condition, observation, or goal. | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
value[x] | S | 1..1 | Reference(SDOHCC Goal) | Value of extension |
Slices for basedOn | S | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure Slice: Unordered, Open by profile:resolve() |
basedOn:SupportedBasedOn | S | 0..* | Reference(SDOHCC ServiceRequest) | An SDOH service request for this procedure |
category | 0..1 | CodeableConcept | Classification of the procedure | |
Slices for coding | S | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this |
coding:SDOH | S | 0..1 | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
code | 1..1 | CodeableConcept | Procedure codes from SNOMED CT, CPT, HCPCS II, ICD-10PC, or CDT Binding: US Core Procedure Codes (required) | |
performed[x] | 1..1 | dateTime, Period | When the procedure was performed | |
reasonCode | 0..* | CodeableConcept | Coded reason procedure performed | |
Slices for reasonReference | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed Slice: Unordered, Open by profile:resolve() | |
reasonReference:SupportedReasonReference | S | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | The justification that the procedure was performed |
Documentation for this format |
Path | Conformance | ValueSet |
Procedure.category.coding:SDOH | required | SDOHCCValueSetSDOHCategory |
Procedure.code | required | USCoreProcedureCodes |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | 0..* | USCoreProcedureProfile | An action that addresses an SDOH condition, observation, or goal. | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal" | |
value[x] | S | 1..1 | Reference(SDOHCC Goal) | Value of extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for basedOn | SΣ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure Slice: Unordered, Open by profile:resolve() |
basedOn:SupportedBasedOn | SΣ | 0..* | Reference(SDOHCC ServiceRequest) | An SDOH service request for this procedure |
status | ?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) |
category | Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. |
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this |
coding:SDOH | SΣ | 0..1 | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
code | SΣ | 1..1 | CodeableConcept | Procedure codes from SNOMED CT, CPT, HCPCS II, ICD-10PC, or CDT Binding: US Core Procedure Codes (required) |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who the procedure was performed on |
performed[x] | SΣ | 1..1 | When the procedure was performed | |
performedDateTime | dateTime | |||
performedPeriod | Period | |||
reasonCode | Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. |
Slices for reasonReference | Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed Slice: Unordered, Open by profile:resolve() |
reasonReference:SupportedReasonReference | SΣ | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | The justification that the procedure was performed |
Documentation for this format |
Path | Conformance | ValueSet |
Procedure.status | required | EventStatus |
Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT) |
Procedure.category.coding:SDOH | required | SDOHCCValueSetSDOHCategory |
Procedure.code | required | USCoreProcedureCodes |
Procedure.reasonCode | example | ProcedureReasonCodes |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Procedure | 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 | error | Procedure | 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 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Procedure | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Procedure | 0..* | USCoreProcedureProfile | An action that addresses an SDOH condition, observation, or goal. | |||||
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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal" | |||||
value[x] | S | 1..1 | Reference(SDOHCC Goal) | Value of extension | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Identifiers for this procedure | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
Slices for basedOn | SΣ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure Slice: Unordered, Open by profile:resolve() | ||||
basedOn:SupportedBasedOn | SΣ | 0..* | Reference(SDOHCC ServiceRequest) | An SDOH service request for this procedure | ||||
partOf | Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) | ||||
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||
category | Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
coding:SDOH | SΣ | 0..1 | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
code | SΣ | 1..1 | CodeableConcept | Procedure codes from SNOMED CT, CPT, HCPCS II, ICD-10PC, or CDT Binding: US Core Procedure Codes (required) | ||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who the procedure was performed on | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
performed[x] | SΣ | 1..1 | When the procedure was performed | |||||
performedDateTime | dateTime | |||||||
performedPeriod | Period | |||||||
recorder | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||
performer | Σ | 0..* | BackboneElement | The people who performed the procedure | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner | ||||
onBehalfOf | 0..1 | Reference(Organization) | Organization the device or practitioner was acting for | |||||
location | Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||
reasonCode | Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. | ||||
Slices for reasonReference | Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed Slice: Unordered, Open by profile:resolve() | ||||
reasonReference:SupportedReasonReference | SΣ | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | The justification that the procedure was performed | ||||
bodySite | Σ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
outcome | Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||
report | 0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||
complicationDetail | 0..* | Reference(Condition) | A condition that is a result of the procedure | |||||
followUp | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||
note | 0..* | Annotation | Additional information about the procedure | |||||
focalDevice | 0..* | BackboneElement | Manipulated, implanted, or removed device | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
action | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||
manipulated | 1..1 | Reference(Device) | Device that was changed | |||||
usedReference | 0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||
usedCode | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Procedure.language | preferred | CommonLanguages
| ||||
Procedure.status | required | EventStatus | ||||
Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT) | ||||
Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT) | ||||
Procedure.category.coding:SDOH | required | SDOHCCValueSetSDOHCategory | ||||
Procedure.code | required | USCoreProcedureCodes | ||||
Procedure.performer.function | example | ProcedurePerformerRoleCodes | ||||
Procedure.reasonCode | example | ProcedureReasonCodes | ||||
Procedure.bodySite | example | SNOMEDCTBodyStructures | ||||
Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT) | ||||
Procedure.complication | example | Condition/Problem/DiagnosisCodes | ||||
Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT) | ||||
Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodes | ||||
Procedure.usedCode | example | FHIRDeviceTypes |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreProcedureProfile
Summary
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron