HL7 Europe Imaging Report R5
0.1.1-build - 150

HL7 Europe Imaging Report R5, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.1-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging-r5/ and changes regularly. See the Directory of published versions

Resource Profile: Procedure: Imaging Acquisition

Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ProcedureEuImaging Version: 0.1.1-build
Standards status: Draft Draft as of 2025-10-20 Maturity Level: 1 Computable Name: ProcedureEuImaging

Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).

This profile on Procedure represents the imaging procedure.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... code Σ 1..1 CodeableConcept Identification of the procedure
Binding: Imaging Procedure Type (extensible)
... subject Σ 1..1 Reference(Patient | Group | Device | Practitioner | Organization | Location) Individual or entity the procedure was performed on
... Slices for performer ΣC 0..* BackboneElement Who performed the procedure and what they did
Slice: Unordered, Open by value:function
Constraints: prc-1
.... performer:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 1..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
..... actor ΣC 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam | HealthcareService) Who performed the procedure
.... performer:performer ΣC 0..* BackboneElement Who performed the procedure and what they did
Constraints: prc-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 1..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
...... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:""$this""
....... coding:healthcare-professional Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 223366009
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
..... actor ΣC 1..1 Reference(PractitionerRole (EU core)) Who performed the procedure
.... performer:imaging-device ΣC 0..* BackboneElement Who performed the procedure and what they did
Constraints: prc-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 1..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
...... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:""$this""
....... coding:imaging-equipment Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 314789007
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
..... actor ΣC 1..1 Reference(Device: Imaging Device) Who performed the procedure

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Procedure.status Base required EventStatus 📍5.0.0 FHIR Std.
Procedure.code Base extensible Imaging Procedure Type 📦0.1.1-build This IG
Procedure.performer.​function Base example Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Procedure.performer:performer.​function Base example Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Procedure.performer:imaging-device.​function Base example Procedure Performer Role Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
prc-1 error Procedure.performer, Procedure.performer:performer, Procedure.performer:imaging-device Procedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole onBehalfOf.exists() and actor.resolve().exists() implies actor.resolve().where($this is Practitioner or $this is PractitionerRole).empty()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... code 1..1 CodeableConcept Identification of the procedure
Binding: Imaging Procedure Type (extensible)
... Slices for performer 0..* BackboneElement Who performed the procedure and what they did
Slice: Unordered, Open by value:function
.... performer:All Slices Content/Rules for all slices
..... function 1..1 CodeableConcept Type of performance
.... performer:performer 0..* BackboneElement Who performed the procedure and what they did
..... function
...... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:""$this""
....... coding:healthcare-professional 0..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 223366009
..... actor 1..1 Reference(PractitionerRole (EU core)) Who performed the procedure
.... performer:imaging-device 0..* BackboneElement Who performed the procedure and what they did
..... function
...... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:""$this""
....... coding:imaging-equipment 0..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 314789007
..... actor 1..1 Reference(Device: Imaging Device) Who performed the procedure

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Procedure.code Base extensible Imaging Procedure Type 📦0.1.1-build This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 ?!Σ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.
... statusReason Σ 0..1 CodeableConcept Reason for current status
Binding: ProcedureNotPerformedReasonSNOMEDCT (example): A code that identifies the reason a procedure was not performed.
... category Σ 0..* CodeableConcept Classification of the procedure
Binding: ProcedureCategoryCodesSNOMEDCT (example): A code that classifies a procedure for searching, sorting and display purposes.
... code Σ 1..1 CodeableConcept Identification of the procedure
Binding: Imaging Procedure Type (extensible)
... subject Σ 1..1 Reference(Patient | Group | Device | Practitioner | Organization | Location) Individual or entity the procedure was performed on
... focus Σ 0..1 Reference(Patient | Group | RelatedPerson | Practitioner | Organization | CareTeam | PractitionerRole | Specimen) Who is the target of the procedure when it is not the subject of record only
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this Procedure was created
... occurrence[x] Σ 0..1 When the procedure occurred or is occurring
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceString string
.... occurrenceAge Age
.... occurrenceRange Range
.... occurrenceTiming Timing
... recorded Σ 0..1 dateTime When the procedure was first captured in the subject's record
... recorder Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who recorded the procedure
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)
... Slices for performer ΣC 0..* BackboneElement Who performed the procedure and what they did
Slice: Unordered, Open by value:function
Constraints: prc-1
.... performer:All Slices Content/Rules for all slices
..... 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 Σ 1..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
..... actor ΣC 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam | HealthcareService) Who performed the procedure
..... onBehalfOf C 0..1 Reference(Organization) Organization the device or practitioner was acting for
..... period 0..1 Period When the performer performed the procedure
.... performer:performer ΣC 0..* BackboneElement Who performed the procedure and what they did
Constraints: prc-1
..... 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 Σ 1..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:""$this""
....... coding:healthcare-professional Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 223366009
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... actor ΣC 1..1 Reference(PractitionerRole (EU core)) Who performed the procedure
..... onBehalfOf C 0..1 Reference(Organization) Organization the device or practitioner was acting for
..... period 0..1 Period When the performer performed the procedure
.... performer:imaging-device ΣC 0..* BackboneElement Who performed the procedure and what they did
Constraints: prc-1
..... 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 Σ 1..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:""$this""
....... coding:imaging-equipment Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 314789007
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... actor ΣC 1..1 Reference(Device: Imaging Device) Who performed the procedure
..... onBehalfOf C 0..1 Reference(Organization) Organization the device or practitioner was acting for
..... period 0..1 Period When the performer performed the procedure
... location Σ 0..1 Reference(Location) Where the procedure happened
... reason Σ 0..* CodeableReference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) The justification that the procedure was performed
Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
... bodySite Σ 0..* CodeableConcept Target body sites
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
... outcome Σ 0..1 CodeableConcept The result of procedure
Binding: ProcedureOutcomeCodesSNOMEDCT (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..* CodeableReference(Condition) Complication following the procedure
Binding: ConditionProblemDiagnosisCodes (example): Codes describing complications that resulted from a procedure.
... followUp 0..* CodeableConcept Instructions for follow up
Binding: ProcedureFollowUpCodesSNOMEDCT (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
... used 0..* CodeableReference(Device | Medication | Substance | BiologicallyDerivedProduct) Items used during procedure
Binding: DeviceType (example): Codes describing items used during a procedure.
... supportingInfo 0..* Reference(Resource) Extra information relevant to the procedure

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Procedure.language Base required All Languages 📍5.0.0 FHIR Std.
Procedure.status Base required EventStatus 📍5.0.0 FHIR Std.
Procedure.statusReason Base example Procedure Not Performed Reason (SNOMED-CT) 📍5.0.0 FHIR Std.
Procedure.category Base example Procedure Category Codes (SNOMED CT) 📍5.0.0 FHIR Std.
Procedure.code Base extensible Imaging Procedure Type 📦0.1.1-build This IG
Procedure.performer.​function Base example Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Procedure.performer:performer.​function Base example Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Procedure.performer:imaging-device.​function Base example Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Procedure.reason Base example Procedure Reason Codes 📍5.0.0 FHIR Std.
Procedure.bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
Procedure.outcome Base example Procedure Outcome Codes (SNOMED CT) 📍5.0.0 FHIR Std.
Procedure.complication Base example Condition/Problem/Diagnosis Codes 📍5.0.0 FHIR Std.
Procedure.followUp Base example Procedure Follow up Codes (SNOMED CT) 📍5.0.0 FHIR Std.
Procedure.focalDevice.​action Base preferred Procedure Device Action Codes 📍5.0.0 FHIR Std.
Procedure.used Base example Device Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
prc-1 error Procedure.performer, Procedure.performer:performer, Procedure.performer:imaging-device Procedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole onBehalfOf.exists() and actor.resolve().exists() implies actor.resolve().where($this is Practitioner or $this is PractitionerRole).empty()

Summary

Mandatory: 1 element(1 nested mandatory element)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Procedure.performer
  • The element 1 is sliced based on the value of Procedure.performer.function.coding

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... code Σ 1..1 CodeableConcept Identification of the procedure
Binding: Imaging Procedure Type (extensible)
... subject Σ 1..1 Reference(Patient | Group | Device | Practitioner | Organization | Location) Individual or entity the procedure was performed on
... Slices for performer ΣC 0..* BackboneElement Who performed the procedure and what they did
Slice: Unordered, Open by value:function
Constraints: prc-1
.... performer:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 1..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
..... actor ΣC 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam | HealthcareService) Who performed the procedure
.... performer:performer ΣC 0..* BackboneElement Who performed the procedure and what they did
Constraints: prc-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 1..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
...... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:""$this""
....... coding:healthcare-professional Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 223366009
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
..... actor ΣC 1..1 Reference(PractitionerRole (EU core)) Who performed the procedure
.... performer:imaging-device ΣC 0..* BackboneElement Who performed the procedure and what they did
Constraints: prc-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 1..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
...... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:""$this""
....... coding:imaging-equipment Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 314789007
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
..... actor ΣC 1..1 Reference(Device: Imaging Device) Who performed the procedure

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Procedure.status Base required EventStatus 📍5.0.0 FHIR Std.
Procedure.code Base extensible Imaging Procedure Type 📦0.1.1-build This IG
Procedure.performer.​function Base example Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Procedure.performer:performer.​function Base example Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Procedure.performer:imaging-device.​function Base example Procedure Performer Role Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
prc-1 error Procedure.performer, Procedure.performer:performer, Procedure.performer:imaging-device Procedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole onBehalfOf.exists() and actor.resolve().exists() implies actor.resolve().where($this is Practitioner or $this is PractitionerRole).empty()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... code 1..1 CodeableConcept Identification of the procedure
Binding: Imaging Procedure Type (extensible)
... Slices for performer 0..* BackboneElement Who performed the procedure and what they did
Slice: Unordered, Open by value:function
.... performer:All Slices Content/Rules for all slices
..... function 1..1 CodeableConcept Type of performance
.... performer:performer 0..* BackboneElement Who performed the procedure and what they did
..... function
...... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:""$this""
....... coding:healthcare-professional 0..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 223366009
..... actor 1..1 Reference(PractitionerRole (EU core)) Who performed the procedure
.... performer:imaging-device 0..* BackboneElement Who performed the procedure and what they did
..... function
...... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:""$this""
....... coding:imaging-equipment 0..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 314789007
..... actor 1..1 Reference(Device: Imaging Device) Who performed the procedure

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Procedure.code Base extensible Imaging Procedure Type 📦0.1.1-build This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 ?!Σ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.
... statusReason Σ 0..1 CodeableConcept Reason for current status
Binding: ProcedureNotPerformedReasonSNOMEDCT (example): A code that identifies the reason a procedure was not performed.
... category Σ 0..* CodeableConcept Classification of the procedure
Binding: ProcedureCategoryCodesSNOMEDCT (example): A code that classifies a procedure for searching, sorting and display purposes.
... code Σ 1..1 CodeableConcept Identification of the procedure
Binding: Imaging Procedure Type (extensible)
... subject Σ 1..1 Reference(Patient | Group | Device | Practitioner | Organization | Location) Individual or entity the procedure was performed on
... focus Σ 0..1 Reference(Patient | Group | RelatedPerson | Practitioner | Organization | CareTeam | PractitionerRole | Specimen) Who is the target of the procedure when it is not the subject of record only
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this Procedure was created
... occurrence[x] Σ 0..1 When the procedure occurred or is occurring
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceString string
.... occurrenceAge Age
.... occurrenceRange Range
.... occurrenceTiming Timing
... recorded Σ 0..1 dateTime When the procedure was first captured in the subject's record
... recorder Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who recorded the procedure
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)
... Slices for performer ΣC 0..* BackboneElement Who performed the procedure and what they did
Slice: Unordered, Open by value:function
Constraints: prc-1
.... performer:All Slices Content/Rules for all slices
..... 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 Σ 1..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
..... actor ΣC 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam | HealthcareService) Who performed the procedure
..... onBehalfOf C 0..1 Reference(Organization) Organization the device or practitioner was acting for
..... period 0..1 Period When the performer performed the procedure
.... performer:performer ΣC 0..* BackboneElement Who performed the procedure and what they did
Constraints: prc-1
..... 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 Σ 1..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:""$this""
....... coding:healthcare-professional Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 223366009
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... actor ΣC 1..1 Reference(PractitionerRole (EU core)) Who performed the procedure
..... onBehalfOf C 0..1 Reference(Organization) Organization the device or practitioner was acting for
..... period 0..1 Period When the performer performed the procedure
.... performer:imaging-device ΣC 0..* BackboneElement Who performed the procedure and what they did
Constraints: prc-1
..... 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 Σ 1..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:""$this""
....... coding:imaging-equipment Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 314789007
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... actor ΣC 1..1 Reference(Device: Imaging Device) Who performed the procedure
..... onBehalfOf C 0..1 Reference(Organization) Organization the device or practitioner was acting for
..... period 0..1 Period When the performer performed the procedure
... location Σ 0..1 Reference(Location) Where the procedure happened
... reason Σ 0..* CodeableReference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) The justification that the procedure was performed
Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
... bodySite Σ 0..* CodeableConcept Target body sites
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
... outcome Σ 0..1 CodeableConcept The result of procedure
Binding: ProcedureOutcomeCodesSNOMEDCT (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..* CodeableReference(Condition) Complication following the procedure
Binding: ConditionProblemDiagnosisCodes (example): Codes describing complications that resulted from a procedure.
... followUp 0..* CodeableConcept Instructions for follow up
Binding: ProcedureFollowUpCodesSNOMEDCT (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
... used 0..* CodeableReference(Device | Medication | Substance | BiologicallyDerivedProduct) Items used during procedure
Binding: DeviceType (example): Codes describing items used during a procedure.
... supportingInfo 0..* Reference(Resource) Extra information relevant to the procedure

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Procedure.language Base required All Languages 📍5.0.0 FHIR Std.
Procedure.status Base required EventStatus 📍5.0.0 FHIR Std.
Procedure.statusReason Base example Procedure Not Performed Reason (SNOMED-CT) 📍5.0.0 FHIR Std.
Procedure.category Base example Procedure Category Codes (SNOMED CT) 📍5.0.0 FHIR Std.
Procedure.code Base extensible Imaging Procedure Type 📦0.1.1-build This IG
Procedure.performer.​function Base example Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Procedure.performer:performer.​function Base example Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Procedure.performer:imaging-device.​function Base example Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Procedure.reason Base example Procedure Reason Codes 📍5.0.0 FHIR Std.
Procedure.bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
Procedure.outcome Base example Procedure Outcome Codes (SNOMED CT) 📍5.0.0 FHIR Std.
Procedure.complication Base example Condition/Problem/Diagnosis Codes 📍5.0.0 FHIR Std.
Procedure.followUp Base example Procedure Follow up Codes (SNOMED CT) 📍5.0.0 FHIR Std.
Procedure.focalDevice.​action Base preferred Procedure Device Action Codes 📍5.0.0 FHIR Std.
Procedure.used Base example Device Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
prc-1 error Procedure.performer, Procedure.performer:performer, Procedure.performer:imaging-device Procedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole onBehalfOf.exists() and actor.resolve().exists() implies actor.resolve().where($this is Practitioner or $this is PractitionerRole).empty()

Summary

Mandatory: 1 element(1 nested mandatory element)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Procedure.performer
  • The element 1 is sliced based on the value of Procedure.performer.function.coding

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron