HL7 Czech PS Implementation Guide
0.0.1 - ci-build
HL7 Czech PS Implementation Guide
0.0.1 - ci-build
HL7 Czech PS Implementation Guide, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/ps/ and changes regularly. See the Directory of published versions
| Official URL: https://hl7.cz/fhir/ps/StructureDefinition/cz-procedure-obl-ps | Version: 0.0.1 | ||||
| Draft as of 2026-08-15 | Computable Name: CZ_ProcedureObligationsPs | ||||
This profile defines obligations for a procedure in FHIR for the purpose of this guide.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Procedure |
0..* | CZ_ProcedurePs | An action that is being or was performed on a patient This profile also imposes the profile Procedure (IPS) (2.0.1) | ||||||||||||||||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||
 text |
O | 0..1 | Narrative | Textual representation of the procedure This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| |||||||||||||||||||||
  Slices for extension |
Content/Rules for all slices | ||||||||||||||||||||||||
   extension:recorded |
0..1 | dateTime | Date when the procedure was recorded URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Procedure.recorded Constraints: ext-1 | ||||||||||||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||
| status |
?!Σ | 1..1 | code | The status of the procedure Binding: EventStatus (required): A code specifying the state of the procedure. | |||||||||||||||||||||
| code |
OΣ | 1..1 | CodeableConceptIPS(2.0.1) | Identification of the procedure Binding: ProceduresUvIps (2.0.1) (preferred)
| |||||||||||||||||||||
 subject |
OΣ | 1..1 | Reference(Patient (EU core)(2.0.0)) | Who the procedure was performed on
| |||||||||||||||||||||
 reference |
OΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||||||||||||||
| Slices for performed[x] |
OΣ | 1..1 | When the procedure was performed Slice: Unordered, Closed by type:$this
| ||||||||||||||||||||||
 performedDateTime |
dateTime | ||||||||||||||||||||||||
| performedPeriod |
Period | ||||||||||||||||||||||||
| performedString |
string | ||||||||||||||||||||||||
| performedAge |
Age | ||||||||||||||||||||||||
| performedRange |
Range | ||||||||||||||||||||||||
| performed[x]:performedDateTime |
OΣ | 0..1 | dateTime | When the procedure was performed
| |||||||||||||||||||||
| reasonCode |
OΣ | 0..* | CodeableConcept | Why the procedure was performed (code) Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| |||||||||||||||||||||
| reasonReference |
OΣ | 0..* | Reference(Condition (CZ core)(1.1.0) | Observation | Procedure (CZ PS) | DiagnosticReport (CZ core)(1.1.0) | DocumentReference) | Why the procedure was performed (details)
| |||||||||||||||||||||
| outcome |
OΣ | 0..1 | CodeableConcept | Outcome of the procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.
| |||||||||||||||||||||
| complication |
O | 0..* | CodeableConcept | Complications that occurred during the procedure (code) Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.
| |||||||||||||||||||||
| complicationDetail |
O | 0..* | Reference(Condition (EU core)(2.0.0)) | Complications that occurred during the procedure (details)
| |||||||||||||||||||||
 focalDevice |
O | 0..* | BackboneElement | Device implanted, removed or otherwise manipulated
| |||||||||||||||||||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||
| manipulated |
1..1 | Reference(Device) | Device that was changed | ||||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||
| Name | Creator_L3 | Consumer_L3 | Consumer (IPS) | Creator (IPS) |
|---|---|---|---|---|
| Procedure |
||||
| text |
|
|
||
| Slices for extension |
||||
| code |
|
| ||
| subject |
| |||
| reference |
|
| ||
| Slices for performed[x] |
| |||
| performed[x]:performedDateTime |
|
| ||
| reasonCode |
|
|
||
| reasonReference |
|
|
||
| outcome |
|
|
||
| complication |
|
|
||
| complicationDetail |
|
|
||
| focalDevice |
|
|
||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Procedure.code | Base | preferred | Procedures - IPS | 📍2.0.1 | International Patient Summary Implementation Guide v2.0 |
| Procedure.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Procedure.outcome | Base | example | Procedure Outcome Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.complication | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| 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().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 | Procedure.extension:recorded, Procedure.modifierExtension, Procedure.focalDevice.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Name | Creator_L3 | Consumer_L3 | Consumer (IPS) | Creator (IPS) |
|---|---|---|---|---|
| Procedure |
||||
 text |
|
|
||
| code |
|
| ||
| Slices for performed[x] |
||||
| performed[x]:performedDateTime |
|
| ||
| reasonCode |
|
|
||
| reasonReference |
|
|
||
| outcome |
|
|
||
| complication |
|
|
||
| complicationDetail |
|
|
||
| focalDevice |
|
|
||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Procedure |
0..* | CZ_ProcedurePs | An action that is being or was performed on a patient This profile also imposes the profile Procedure (IPS) (2.0.1) | ||||||||||||||||||||||
| 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 procedure Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||||||
| text |
O | 0..1 | Narrative | Textual representation of the procedure This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| |||||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| extension:recorded |
0..1 | dateTime | Date when the procedure was recorded URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Procedure.recorded Constraints: ext-1 | ||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||
| identifier |
Σ | 0..* | Identifier | Identifier for the 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 | The status of the procedure Binding: EventStatus (required): A code specifying the state of the procedure. | |||||||||||||||||||||
| 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 |
OΣ | 1..1 | CodeableConceptIPS(2.0.1) | Identification of the procedure Binding: ProceduresUvIps (2.0.1) (preferred)
| |||||||||||||||||||||
| subject |
OΣ | 1..1 | Reference(Patient (EU core)(2.0.0)) | Who the procedure was performed on
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| reference |
OΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | |||||||||||||||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | |||||||||||||||||||||
| Slices for performed[x] |
OΣ | 1..1 | When the procedure was performed Slice: Unordered, Closed by type:$this
| ||||||||||||||||||||||
| performedDateTime |
dateTime | ||||||||||||||||||||||||
| performedPeriod |
Period | ||||||||||||||||||||||||
| performedString |
string | ||||||||||||||||||||||||
| performedAge |
Age | ||||||||||||||||||||||||
| performedRange |
Range | ||||||||||||||||||||||||
| performed[x]:performedDateTime |
OΣ | 0..1 | dateTime | When the procedure was performed
| |||||||||||||||||||||
| recorder |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | The person or organization who recorded the procedure | |||||||||||||||||||||
| asserter |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | The person or organization who asserts the 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 (CZ core)(1.1.0) | Practitioner Role (CZ core)(1.1.0) | Patient (EPS) | Related Person (CZ core)(1.1.0) | Organization (CZ core)(1.1.0)) | The reference to the practitioner | |||||||||||||||||||||
| onBehalfOf |
0..1 | Reference(Organization (CZ core)(1.1.0)) | Organization the device or practitioner was acting for | ||||||||||||||||||||||
| location |
Σ | 0..1 | Reference(Location) | Where the procedure happened | |||||||||||||||||||||
| reasonCode |
OΣ | 0..* | CodeableConcept | Why the procedure was performed (code) Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| |||||||||||||||||||||
| reasonReference |
OΣ | 0..* | Reference(Condition (CZ core)(1.1.0) | Observation | Procedure (CZ PS) | DiagnosticReport (CZ core)(1.1.0) | DocumentReference) | Why the procedure was performed (details)
| |||||||||||||||||||||
| bodySite |
ΣC | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (preferred) Constraints: eu-bodysite-1 | |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
 extension:bodySite |
0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | ||||||||||||||||||||||
 id |
0..1 | id | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | ||||||||||||||||||||||
 value[x] |
1..1 | Reference(BodyStructure (EU core)(2.0.0)) | Value of extension | ||||||||||||||||||||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | |||||||||||||||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||
| outcome |
OΣ | 0..1 | CodeableConcept | Outcome of the 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 |
O | 0..* | CodeableConcept | Complications that occurred during the procedure (code) Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.
| |||||||||||||||||||||
| complicationDetail |
O | 0..* | Reference(Condition (EU core)(2.0.0)) | Complications that occurred during the procedure (details)
| |||||||||||||||||||||
| 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 |
O | 0..* | BackboneElement | Device implanted, removed or otherwise manipulated
| |||||||||||||||||||||
| 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 (EU core)(2.0.0) | Substance) | Items used during procedure | ||||||||||||||||||||||
| usedCode |
0..* | CodeableConcept | Device used to perform the procedure (code) Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | ||||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||
| Name | Creator_L3 | Consumer_L3 | Consumer (IPS) | Creator (IPS) |
|---|---|---|---|---|
| Procedure |
||||
| text |
|
|
||
| Slices for extension |
||||
| code |
|
| ||
| subject |
| |||
| reference |
|
| ||
| Slices for performed[x] |
| |||
| performed[x]:performedDateTime |
|
| ||
| reasonCode |
|
|
||
| reasonReference |
|
|
||
| outcome |
|
|
||
| complication |
|
|
||
| complicationDetail |
|
|
||
| focalDevice |
|
|
||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Procedure.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Procedure.statusReason | Base | example | Procedure Not Performed Reason (SNOMED-CT) | 📍4.0.1 | FHIR Std. |
| Procedure.category | Base | example | Procedure Category Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.code | Base | preferred | Procedures - IPS | 📍2.0.1 | International Patient Summary Implementation Guide v2.0 |
| Procedure.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Procedure.performer.function | Base | example | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std. |
| Procedure.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Procedure.bodySite | Base | preferred | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Procedure.outcome | Base | example | Procedure Outcome Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.complication | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| Procedure.followUp | Base | example | Procedure Follow up Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.focalDevice.action | Base | preferred | Procedure Device Action Codes | 📍4.0.1 | FHIR Std. |
| Procedure.usedCode | Base | example | FHIR Device Types | 📍4.0.1 | FHIR Std. |
| 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().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())
|
| eu-bodysite-1 | error | Procedure.bodySite | Either a body site code or a reference to a BodyStructure resource SHALL be used, but not both. |
(coding.empty() and text.empty()) or extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Name | Creator_L3 | Consumer_L3 | Consumer (IPS) | Creator (IPS) |
|---|---|---|---|---|
| Procedure |
||||
| text |
|
|
||
| Slices for extension |
||||
| code |
|
| ||
| subject |
| |||
| reference |
|
| ||
| Slices for performed[x] |
| |||
| performed[x]:performedDateTime |
|
| ||
| reasonCode |
|
|
||
| reasonReference |
|
|
||
| outcome |
|
|
||
| complication |
|
|
||
| complicationDetail |
|
|
||
| focalDevice |
|
|
||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Procedure |
0..* | CZ_ProcedurePs | An action that is being or was performed on a patient This profile also imposes the profile Procedure (IPS) (2.0.1) | ||||||||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||
| text |
O | 0..1 | Narrative | Textual representation of the procedure This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| |||||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | ||||||||||||||||||||||||
| extension:recorded |
0..1 | dateTime | Date when the procedure was recorded URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Procedure.recorded Constraints: ext-1 | ||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||
| status |
?!Σ | 1..1 | code | The status of the procedure Binding: EventStatus (required): A code specifying the state of the procedure. | |||||||||||||||||||||
| code |
OΣ | 1..1 | CodeableConceptIPS(2.0.1) | Identification of the procedure Binding: ProceduresUvIps (2.0.1) (preferred)
| |||||||||||||||||||||
| subject |
OΣ | 1..1 | Reference(Patient (EU core)(2.0.0)) | Who the procedure was performed on
| |||||||||||||||||||||
| reference |
OΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||||||||||||||
| Slices for performed[x] |
OΣ | 1..1 | When the procedure was performed Slice: Unordered, Closed by type:$this
| ||||||||||||||||||||||
| performedDateTime |
dateTime | ||||||||||||||||||||||||
| performedPeriod |
Period | ||||||||||||||||||||||||
| performedString |
string | ||||||||||||||||||||||||
| performedAge |
Age | ||||||||||||||||||||||||
| performedRange |
Range | ||||||||||||||||||||||||
| performed[x]:performedDateTime |
OΣ | 0..1 | dateTime | When the procedure was performed
| |||||||||||||||||||||
| reasonCode |
OΣ | 0..* | CodeableConcept | Why the procedure was performed (code) Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| |||||||||||||||||||||
| reasonReference |
OΣ | 0..* | Reference(Condition (CZ core)(1.1.0) | Observation | Procedure (CZ PS) | DiagnosticReport (CZ core)(1.1.0) | DocumentReference) | Why the procedure was performed (details)
| |||||||||||||||||||||
| outcome |
OΣ | 0..1 | CodeableConcept | Outcome of the procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.
| |||||||||||||||||||||
| complication |
O | 0..* | CodeableConcept | Complications that occurred during the procedure (code) Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.
| |||||||||||||||||||||
| complicationDetail |
O | 0..* | Reference(Condition (EU core)(2.0.0)) | Complications that occurred during the procedure (details)
| |||||||||||||||||||||
| focalDevice |
O | 0..* | BackboneElement | Device implanted, removed or otherwise manipulated
| |||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||
| manipulated |
1..1 | Reference(Device) | Device that was changed | ||||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||
| Name | Creator_L3 | Consumer_L3 | Consumer (IPS) | Creator (IPS) |
|---|---|---|---|---|
| Procedure |
||||
| text |
|
|
||
| Slices for extension |
||||
| code |
|
| ||
| subject |
| |||
| reference |
|
| ||
| Slices for performed[x] |
| |||
| performed[x]:performedDateTime |
|
| ||
| reasonCode |
|
|
||
| reasonReference |
|
|
||
| outcome |
|
|
||
| complication |
|
|
||
| complicationDetail |
|
|
||
| focalDevice |
|
|
||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Procedure.code | Base | preferred | Procedures - IPS | 📍2.0.1 | International Patient Summary Implementation Guide v2.0 |
| Procedure.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Procedure.outcome | Base | example | Procedure Outcome Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.complication | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| 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().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 | Procedure.extension:recorded, Procedure.modifierExtension, Procedure.focalDevice.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Procedure |
0..* | CZ_ProcedurePs | An action that is being or was performed on a patient This profile also imposes the profile Procedure (IPS) (2.0.1) | |||||||||||||
| text |
O | 0..1 | Narrative | Textual representation of the procedure
| ||||||||||||
| code |
O | 1..1 | CodeableConceptIPS(2.0.1) | Identification of the procedure
| ||||||||||||
| Slices for performed[x] |
Content/Rules for all slices | |||||||||||||||
| performed[x]:performedDateTime |
O | 0..1 | dateTime | When the procedure was performed
| ||||||||||||
| reasonCode |
O | 0..* | CodeableConcept | Why the procedure was performed (code)
| ||||||||||||
| reasonReference |
O | 0..* | Reference(Condition (CZ core)(1.1.0) | Observation | Procedure (CZ PS) | DiagnosticReport (CZ core)(1.1.0) | DocumentReference) | Why the procedure was performed (details)
| ||||||||||||
| outcome |
O | 0..1 | CodeableConcept | Outcome of the procedure
| ||||||||||||
| complication |
O | 0..* | CodeableConcept | Complications that occurred during the procedure (code)
| ||||||||||||
| complicationDetail |
O | 0..* | Reference(Condition (EU core)(2.0.0)) | Complications that occurred during the procedure (details)
| ||||||||||||
| focalDevice |
O | 0..* | BackboneElement | Device implanted, removed or otherwise manipulated
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | Creator_L3 | Consumer_L3 | Consumer (IPS) | Creator (IPS) |
|---|---|---|---|---|
| Procedure |
||||
| text |
|
|
||
| code |
|
| ||
| Slices for performed[x] |
||||
| performed[x]:performedDateTime |
|
| ||
| reasonCode |
|
|
||
| reasonReference |
|
|
||
| outcome |
|
|
||
| complication |
|
|
||
| complicationDetail |
|
|
||
| focalDevice |
|
|
||
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Procedure |
0..* | CZ_ProcedurePs | An action that is being or was performed on a patient This profile also imposes the profile Procedure (IPS) (2.0.1) | ||||||||||||||||||||||
| 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 procedure Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||||||
| text |
O | 0..1 | Narrative | Textual representation of the procedure This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| |||||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| extension:recorded |
0..1 | dateTime | Date when the procedure was recorded URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Procedure.recorded Constraints: ext-1 | ||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||
| identifier |
Σ | 0..* | Identifier | Identifier for the 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 | The status of the procedure Binding: EventStatus (required): A code specifying the state of the procedure. | |||||||||||||||||||||
| 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 |
OΣ | 1..1 | CodeableConceptIPS(2.0.1) | Identification of the procedure Binding: ProceduresUvIps (2.0.1) (preferred)
| |||||||||||||||||||||
| subject |
OΣ | 1..1 | Reference(Patient (EU core)(2.0.0)) | Who the procedure was performed on
| |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| reference |
OΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | |||||||||||||||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | |||||||||||||||||||||
| Slices for performed[x] |
OΣ | 1..1 | When the procedure was performed Slice: Unordered, Closed by type:$this
| ||||||||||||||||||||||
| performedDateTime |
dateTime | ||||||||||||||||||||||||
| performedPeriod |
Period | ||||||||||||||||||||||||
| performedString |
string | ||||||||||||||||||||||||
| performedAge |
Age | ||||||||||||||||||||||||
| performedRange |
Range | ||||||||||||||||||||||||
| performed[x]:performedDateTime |
OΣ | 0..1 | dateTime | When the procedure was performed
| |||||||||||||||||||||
| recorder |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | The person or organization who recorded the procedure | |||||||||||||||||||||
| asserter |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | The person or organization who asserts the 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 (CZ core)(1.1.0) | Practitioner Role (CZ core)(1.1.0) | Patient (EPS) | Related Person (CZ core)(1.1.0) | Organization (CZ core)(1.1.0)) | The reference to the practitioner | |||||||||||||||||||||
| onBehalfOf |
0..1 | Reference(Organization (CZ core)(1.1.0)) | Organization the device or practitioner was acting for | ||||||||||||||||||||||
| location |
Σ | 0..1 | Reference(Location) | Where the procedure happened | |||||||||||||||||||||
| reasonCode |
OΣ | 0..* | CodeableConcept | Why the procedure was performed (code) Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| |||||||||||||||||||||
| reasonReference |
OΣ | 0..* | Reference(Condition (CZ core)(1.1.0) | Observation | Procedure (CZ PS) | DiagnosticReport (CZ core)(1.1.0) | DocumentReference) | Why the procedure was performed (details)
| |||||||||||||||||||||
| bodySite |
ΣC | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (preferred) Constraints: eu-bodysite-1 | |||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||
| extension:bodySite |
0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | ||||||||||||||||||||||
| id |
0..1 | id | Unique id for inter-element referencing | ||||||||||||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | ||||||||||||||||||||||
| value[x] |
1..1 | Reference(BodyStructure (EU core)(2.0.0)) | Value of extension | ||||||||||||||||||||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | |||||||||||||||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||
| outcome |
OΣ | 0..1 | CodeableConcept | Outcome of the 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 |
O | 0..* | CodeableConcept | Complications that occurred during the procedure (code) Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.
| |||||||||||||||||||||
| complicationDetail |
O | 0..* | Reference(Condition (EU core)(2.0.0)) | Complications that occurred during the procedure (details)
| |||||||||||||||||||||
| 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 |
O | 0..* | BackboneElement | Device implanted, removed or otherwise manipulated
| |||||||||||||||||||||
| 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 (EU core)(2.0.0) | Substance) | Items used during procedure | ||||||||||||||||||||||
| usedCode |
0..* | CodeableConcept | Device used to perform the procedure (code) Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | ||||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||
| Name | Creator_L3 | Consumer_L3 | Consumer (IPS) | Creator (IPS) |
|---|---|---|---|---|
| Procedure |
||||
| text |
|
|
||
| Slices for extension |
||||
| code |
|
| ||
| subject |
| |||
| reference |
|
| ||
| Slices for performed[x] |
| |||
| performed[x]:performedDateTime |
|
| ||
| reasonCode |
|
|
||
| reasonReference |
|
|
||
| outcome |
|
|
||
| complication |
|
|
||
| complicationDetail |
|
|
||
| focalDevice |
|
|
||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Procedure.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Procedure.statusReason | Base | example | Procedure Not Performed Reason (SNOMED-CT) | 📍4.0.1 | FHIR Std. |
| Procedure.category | Base | example | Procedure Category Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.code | Base | preferred | Procedures - IPS | 📍2.0.1 | International Patient Summary Implementation Guide v2.0 |
| Procedure.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Procedure.performer.function | Base | example | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std. |
| Procedure.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Procedure.bodySite | Base | preferred | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Procedure.outcome | Base | example | Procedure Outcome Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.complication | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| Procedure.followUp | Base | example | Procedure Follow up Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.focalDevice.action | Base | preferred | Procedure Device Action Codes | 📍4.0.1 | FHIR Std. |
| Procedure.usedCode | Base | example | FHIR Device Types | 📍4.0.1 | FHIR Std. |
| 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().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())
|
| eu-bodysite-1 | error | Procedure.bodySite | Either a body site code or a reference to a BodyStructure resource SHALL be used, but not both. |
(coding.empty() and text.empty()) or extension('http://hl7.org/fhir/StructureDefinition/bodySite').empty()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Name | Creator_L3 | Consumer_L3 | Consumer (IPS) | Creator (IPS) |
|---|---|---|---|---|
| Procedure |
||||
| text |
|
|
||
| Slices for extension |
||||
| code |
|
| ||
| subject |
| |||
| reference |
|
| ||
| Slices for performed[x] |
| |||
| performed[x]:performedDateTime |
|
| ||
| reasonCode |
|
|
||
| reasonReference |
|
|
||
| outcome |
|
|
||
| complication |
|
|
||
| complicationDetail |
|
|
||
| focalDevice |
|
|
||
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
