HL7.FHIR.US.ECR\eICR Procedure

HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.0.0 - STU 2

This page is part of the electronic Case Reporting (eCR) (v2.0.0: STU 2 on FHIR R4) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: eICR Procedure

Defining URL:

http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-procedure

Version:

2.0.0

Name:

EICRProcedure

Title:

eICR Procedure

Status:

Active as of 1/18/22 12:57 PM

Definition:

This Procedure profile defines constraints on the US Core Procedure profile for the eICR use case.

Publisher:

HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-procedure

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from USCoreProcedureProfile

Summary

Must-Support: 2 elements

This structure is derived from USCoreProcedureProfile

Name	Flags	Card.	Type	Description & Constraints
Procedure		0..*	USCoreProcedureProfile	Defines constraints on the US Core Procedure profile for US Public Health use cases.
focalDevice	S	0..*	BackboneElement	Device such as a ventilator as the focus of the procedure
manipulated	S	1..1	Reference(Device)	Device that was changed
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Procedure		0..*	USCoreProcedureProfile	Defines constraints on the US Core Procedure profile for US Public Health use cases.
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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
basedOn	Σ	0..*	Reference(CarePlan \| ServiceRequest)	A 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.
code	SΣ	1..1	CodeableConcept	Identification of the procedure Binding: US Core Procedure Codes (extensible): Codes describing the type of Procedure
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 S
performedPeriod			Period
performedString			string
performedAge			Age
performedRange			Range
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.
reasonReference	Σ	0..*	Reference(Condition \| Observation \| Procedure \| DiagnosticReport \| DocumentReference)	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	S	0..*	BackboneElement	Device such as a ventilator as the focus of 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
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	S	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

Name	Flags	Card.	Type	Description & Constraints
Procedure		0..*	USCoreProcedureProfile	Defines constraints on the US Core Procedure profile for US Public Health use cases.
status	?!Σ	1..1	code	preparation \| in-progress \| not-done \| on-hold \| stopped \| completed \| entered-in-error \| unknown Binding: EventStatus (required)
code	Σ	1..1	CodeableConcept	Identification of the procedure Binding: US Core Procedure Codes (extensible): Codes describing the type of Procedure
subject	Σ	1..1	Reference(US Core Patient Profile)	Who the procedure was performed on
performed[x]	Σ	1..1		When the procedure was performed
performedDateTime			dateTime
focalDevice		0..*	BackboneElement	Device such as a ventilator as the focus of the procedure
manipulated		1..1	Reference(Device)	Device that was changed
Documentation for this format

This structure is derived from USCoreProcedureProfile

Summary

Must-Support: 2 elements

Differential View

This structure is derived from USCoreProcedureProfile

Name	Flags	Card.	Type	Description & Constraints
Procedure		0..*	USCoreProcedureProfile	Defines constraints on the US Core Procedure profile for US Public Health use cases.
focalDevice	S	0..*	BackboneElement	Device such as a ventilator as the focus of the procedure
manipulated	S	1..1	Reference(Device)	Device that was changed
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Procedure		0..*	USCoreProcedureProfile	Defines constraints on the US Core Procedure profile for US Public Health use cases.
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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
basedOn	Σ	0..*	Reference(CarePlan \| ServiceRequest)	A 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.
code	SΣ	1..1	CodeableConcept	Identification of the procedure Binding: US Core Procedure Codes (extensible): Codes describing the type of Procedure
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 S
performedPeriod			Period
performedString			string
performedAge			Age
performedRange			Range
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.
reasonReference	Σ	0..*	Reference(Condition \| Observation \| Procedure \| DiagnosticReport \| DocumentReference)	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	S	0..*	BackboneElement	Device such as a ventilator as the focus of 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
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	S	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

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
Procedure.language	preferred	CommonLanguages Max Binding: AllLanguages
Procedure.status	required	EventStatus
Procedure.statusReason	example	ProcedureNotPerformedReason(SNOMED-CT)
Procedure.category	example	ProcedureCategoryCodes(SNOMEDCT)
Procedure.code	extensible	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

Constraints

Id	Grade	Path	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	Procedure.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Procedure.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Procedure.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Procedure.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Procedure.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.instantiatesCanonical	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.instantiatesUri	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.basedOn	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.partOf	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.statusReason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.category	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.subject	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.encounter	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.performed[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.recorder	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.asserter	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.performer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.performer.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Procedure.performer.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Procedure.performer.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Procedure.performer.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Procedure.performer.function	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.performer.actor	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.performer.onBehalfOf	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.location	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.reasonCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.reasonReference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.bodySite	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.outcome	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.report	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.complication	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.complicationDetail	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.followUp	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.note	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.focalDevice	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.focalDevice.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Procedure.focalDevice.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Procedure.focalDevice.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Procedure.focalDevice.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Procedure.focalDevice.action	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.focalDevice.manipulated	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.usedReference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Procedure.usedCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2020+ HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm). Package hl7.fhir.us.ecr#2.0.0 based on FHIR 4.0.1. Generated 2022-01-18
Links: Table of Contents | QA Report | Version History | Search | | Propose a change