IKNL PZP STU3
1.0.0-rc1 - consultation International flag

IKNL PZP STU3, published by IKNL. This guide is not an authorized publication; it is the continuous build for version 1.0.0-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IKNL/PZP-FHIR-STU3/ and changes regularly. See the Directory of published versions

Resource Profile: Advance Care Planning Procedure

Official URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Procedure Version: 1.0.0-rc1
Draft as of 2025-10-31 Computable Name: ACPProcedure

Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.

Advance Care Planning procedure. Based on nl-core-Procedure-event profile and HCIM Procedure.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure C 0..* Zib Procedure(2.1.12) Procedure
Constraints: pro-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:procedureMethod 0..1 (Complex) The method used to perform the procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-method
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/procedure-method"
..... Slices for valueCodeableConcept Content/Rules for all slices
...... valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept ProcedureMethod
Binding: VerrichtingMethodeCodelijst (2017-12-31T00:00:00) (extensible): VerrichtingMethodeCodelijst
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... basedOn:request Σ 0..* Reference(HCIM ProcedureRequest(2.1.9)) ProcedureRequest
... status ?!Σ 1..1 code preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.
... notDone ?!Σ 0..1 boolean True if procedure was not performed as scheduled
... category Σ 1..1 CodeableConcept Classification of the procedure
Binding: Procedure Category Codes (SNOMED CT) (example): A code that classifies a procedure for searching, sorting and display purposes.
Example Example of category code: {"coding":[{"system":"http://snomed.info/sct","code":"387713003","display":"Surgical procedure"}]}
... code Σ 1..1 CodeableConcept ProcedureType
Binding: Procedure Codes (SNOMED CT) (example): A code to identify a specific procedure .
Required Pattern: At least the following
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string xml:id (or equivalent in JSON)
..... 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: 713603004
..... 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
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:VerrichtingTypeCodelijst Σ 0..* Coding ProcedureType
Binding: VerrichtingTypeCodelijst (2017-12-31T00:00:00) (required): The name of the procedure using the Verrichtingenthesaurus DHD.
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
... subject Σ 1..1 Reference(Patient(1.0.0-rc1)) Who the procedure was performed on
... context Σ 0..1 Reference(Encounter(1.0.0-rc1)) Encounter or episode associated with the procedure
... Slices for performed[x] Σ 0..1 Date/Period the procedure was performed
Slice: Unordered, Open by type:$this
.... performedDateTime dateTime
.... performedPeriod Period
.... performed[x]:performedPeriod Σ 0..1 Period Date/Period the procedure was performed
... Slices for report 0..* Reference(DiagnosticReport) Any report resulting from the procedure
Slice: Unordered, Open by profile:resolve()
.... report:textResult 0..* Reference(HCIM TextResult(2.1.4)) Any report resulting from the procedure

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Procedure.extension:procedureMethod.​valueCodeableConcept:valueCodeableConcept Base extensible VerrichtingMethodeCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Procedure.status Base required EventStatus 📍3.0.2 FHIR Std.
Procedure.category Base example Procedure Category Codes (SNOMED CT) 📍3.0.2 FHIR Std.
Procedure.code Base example Procedure Codes (SNOMED CT) 📍3.0.2 FHIR Std.
Procedure.code.coding:VerrichtingTypeCodelijst Base required VerrichtingTypeCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3

Constraints

Id Grade Path(s) Description Expression
dom-1 error Procedure If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pro-1 error Procedure Reason not done is only permitted if notDone indicator is true notDoneReason.empty() or notDone = true

This structure is derived from Zib Procedure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Zib Procedure(2.1.12) Procedure
... code 1..1 CodeableConcept ProcedureType
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... 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: 713603004
... subject 1..1 Reference(Patient(1.0.0-rc1)) Who the procedure was performed on
... context 0..1 Reference(Encounter(1.0.0-rc1)) Encounter or episode associated with the procedure
.... actor 1..1 Reference(HealthProfessional Practitioner(1.0.0-rc1)) The reference to the practitioner

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure C 0..* Zib Procedure(2.1.12) Procedure
Constraints: pro-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 resource content
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... 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
... Slices for extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... extension:procedureMethod 0..1 (Complex) The method used to perform the procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-method
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/procedure-method"
..... Slices for valueCodeableConcept Content/Rules for all slices
...... valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept ProcedureMethod
Binding: VerrichtingMethodeCodelijst (2017-12-31T00:00:00) (extensible): VerrichtingMethodeCodelijst
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Identifiers for this procedure
... definition Σ 0..* Reference(PlanDefinition | ActivityDefinition | HealthcareService) Instantiates protocol or definition
... Slices for basedOn Σ 0..* Reference(CarePlan | ProcedureRequest | ReferralRequest) A request for this procedure
Slice: Unordered, Open by type:$this.resolve()
.... basedOn:request Σ 0..* Reference(HCIM ProcedureRequest(2.1.9)) ProcedureRequest
... partOf Σ 0..* Reference(Procedure | Observation | MedicationAdministration) Part of referenced event
... status ?!Σ 1..1 code preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.
... notDone ?!Σ 0..1 boolean True if procedure was not performed as scheduled
... notDoneReason ΣC 0..1 CodeableConcept Reason procedure was not performed
Binding: Procedure Not Performed Reason (SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.
... category Σ 1..1 CodeableConcept Classification of the procedure
Binding: Procedure Category Codes (SNOMED CT) (example): A code that classifies a procedure for searching, sorting and display purposes.
Example Example of category code: {"coding":[{"system":"http://snomed.info/sct","code":"387713003","display":"Surgical procedure"}]}
... code Σ 1..1 CodeableConcept ProcedureType
Binding: Procedure Codes (SNOMED CT) (example): A code to identify a specific procedure .
Required Pattern: At least the following
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string xml:id (or equivalent in JSON)
..... 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: 713603004
..... 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
.... id 0..1 string xml:id (or equivalent in JSON)
.... 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:system
..... coding:VerrichtingTypeCodelijst Σ 0..* Coding ProcedureType
Binding: VerrichtingTypeCodelijst (2017-12-31T00:00:00) (required): The name of the procedure using the Verrichtingenthesaurus DHD.
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... 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 Σ 0..1 code Symbol in syntax defined by the system
...... 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
... subject Σ 1..1 Reference(Patient(1.0.0-rc1)) Who the procedure was performed on
... context Σ 0..1 Reference(Encounter(1.0.0-rc1)) Encounter or episode associated with the procedure
... Slices for performed[x] Σ 0..1 Date/Period the procedure was performed
Slice: Unordered, Open by type:$this
.... performedDateTime dateTime
.... performedPeriod Period
.... performed[x]:performedPeriod Σ 0..1 Period Date/Period the procedure was performed
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime ProcedureStartDate
..... end ΣC 0..1 dateTime ProcedureEndDate
... performer Σ 0..* BackboneElement HealthProfessional | Location::HealthcareProvider
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... role Σ 0..1 CodeableConcept The role the actor was in
Binding: Procedure Performer Role Codes (example): A code that identifies the role of a performer of the procedure.
..... id 0..1 string xml:id (or equivalent in JSON)
..... 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:healthProfessionalRole Σ 0..* Coding HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (2017-12-31T00:00:00) (required)
..... text Σ 0..1 string Plain text representation of the concept
.... actor Σ 1..1 Reference(HealthProfessional Practitioner(1.0.0-rc1)) The reference to the practitioner
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... extension:practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... 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: Procedure Reason Codes (example): A code that identifies the reason a procedure is required.
... reasonReference Σ 0..* Reference(HCIM Problem(3.0.7)) Indication
... bodySite Σ 0..* CodeableConcept ProcedureAnatomicalLocation
Binding: VerrichtingAnatomischeLocatieCodelijst (2017-12-31T00:00:00) (extensible): Anatomical location which is the focus of the procedure.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... extension:ProcedureLaterality 0..1 (Complex) ProcedureLaterality
URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier
Constraints: ext-1
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..0 Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier"
...... value[x] 0..1 CodeableConcept BodySite qualifier
Binding: VerrichtingLateraliteitCodelijst (2017-12-31T00:00:00) (extensible): ProcedureLateralityCodelist
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... outcome Σ 0..1 CodeableConcept The result of procedure
Binding: Procedure Outcome Codes (SNOMED CT) (example): An outcome of a procedure - whether it was resolved or otherwise.
... Slices for report 0..* Reference(DiagnosticReport) Any report resulting from the procedure
Slice: Unordered, Open by profile:resolve()
.... report:textResult 0..* Reference(HCIM TextResult(2.1.4)) Any report resulting from the procedure
... complication 0..* CodeableConcept Complication following the procedure
Binding: Condition/Problem/Diagnosis Codes (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: Procedure Follow up Codes (SNOMED CT) (example): Specific follow up required for a procedure e.g. removal of sutures.
... note 0..* Annotation Additional information about the procedure
... focalDevice 0..* BackboneElement Device changed in procedure
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... action 0..1 CodeableConcept Kind of change to device
Binding: Procedure Device Action Codes (preferred): A kind of change that happened to the device during the procedure.
.... manipulated 1..1 Reference(HCIM MedicalDevice Product(2.0.6)) MedicalDevice
... usedReference 0..* Reference(Device | Medication | Substance) Items used during procedure
... usedCode 0..* CodeableConcept Coded items used during the procedure
Binding: FHIR Device Types (example): Codes describing items used during a procedure

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Procedure.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Procedure.extension:procedureMethod.​valueCodeableConcept:valueCodeableConcept Base extensible VerrichtingMethodeCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Procedure.status Base required EventStatus 📍3.0.2 FHIR Std.
Procedure.notDoneReason Base example Procedure Not Performed Reason (SNOMED-CT) 📍3.0.2 FHIR Std.
Procedure.category Base example Procedure Category Codes (SNOMED CT) 📍3.0.2 FHIR Std.
Procedure.code Base example Procedure Codes (SNOMED CT) 📍3.0.2 FHIR Std.
Procedure.code.coding:VerrichtingTypeCodelijst Base required VerrichtingTypeCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Procedure.performer.​role Base example Procedure Performer Role Codes 📍3.0.2 FHIR Std.
Procedure.performer.​role.coding:healthProfessionalRole Base required ZorgverlenerRolCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Procedure.reasonCode Base example Procedure Reason Codes 📍3.0.2 FHIR Std.
Procedure.bodySite Base extensible VerrichtingAnatomischeLocatieCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Procedure.bodySite.extension:ProcedureLaterality.​value[x] Base extensible VerrichtingLateraliteitCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Procedure.outcome Base example Procedure Outcome Codes (SNOMED CT) 📍3.0.2 FHIR Std.
Procedure.complication Base example Condition/Problem/Diagnosis Codes 📍3.0.2 FHIR Std.
Procedure.followUp Base example Procedure Follow up Codes (SNOMED CT) 📍3.0.2 FHIR Std.
Procedure.focalDevice.​action Base preferred Procedure Device Action Codes 📍3.0.2 FHIR Std.
Procedure.usedCode Base example FHIR Device Types 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Procedure If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ext-1 error Procedure.performer.actor.extension:practitionerRole, Procedure.bodySite.extension:ProcedureLaterality Must have either extensions or value[x], not both extension.exists() != value.exists()
pro-1 error Procedure Reason not done is only permitted if notDone indicator is true notDoneReason.empty() or notDone = true

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure C 0..* Zib Procedure(2.1.12) Procedure
Constraints: pro-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:procedureMethod 0..1 (Complex) The method used to perform the procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-method
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/procedure-method"
..... Slices for valueCodeableConcept Content/Rules for all slices
...... valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept ProcedureMethod
Binding: VerrichtingMethodeCodelijst (2017-12-31T00:00:00) (extensible): VerrichtingMethodeCodelijst
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... basedOn:request Σ 0..* Reference(HCIM ProcedureRequest(2.1.9)) ProcedureRequest
... status ?!Σ 1..1 code preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.
... notDone ?!Σ 0..1 boolean True if procedure was not performed as scheduled
... category Σ 1..1 CodeableConcept Classification of the procedure
Binding: Procedure Category Codes (SNOMED CT) (example): A code that classifies a procedure for searching, sorting and display purposes.
Example Example of category code: {"coding":[{"system":"http://snomed.info/sct","code":"387713003","display":"Surgical procedure"}]}
... code Σ 1..1 CodeableConcept ProcedureType
Binding: Procedure Codes (SNOMED CT) (example): A code to identify a specific procedure .
Required Pattern: At least the following
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string xml:id (or equivalent in JSON)
..... 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: 713603004
..... 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
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:VerrichtingTypeCodelijst Σ 0..* Coding ProcedureType
Binding: VerrichtingTypeCodelijst (2017-12-31T00:00:00) (required): The name of the procedure using the Verrichtingenthesaurus DHD.
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
... subject Σ 1..1 Reference(Patient(1.0.0-rc1)) Who the procedure was performed on
... context Σ 0..1 Reference(Encounter(1.0.0-rc1)) Encounter or episode associated with the procedure
... Slices for performed[x] Σ 0..1 Date/Period the procedure was performed
Slice: Unordered, Open by type:$this
.... performedDateTime dateTime
.... performedPeriod Period
.... performed[x]:performedPeriod Σ 0..1 Period Date/Period the procedure was performed
... Slices for report 0..* Reference(DiagnosticReport) Any report resulting from the procedure
Slice: Unordered, Open by profile:resolve()
.... report:textResult 0..* Reference(HCIM TextResult(2.1.4)) Any report resulting from the procedure

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Procedure.extension:procedureMethod.​valueCodeableConcept:valueCodeableConcept Base extensible VerrichtingMethodeCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Procedure.status Base required EventStatus 📍3.0.2 FHIR Std.
Procedure.category Base example Procedure Category Codes (SNOMED CT) 📍3.0.2 FHIR Std.
Procedure.code Base example Procedure Codes (SNOMED CT) 📍3.0.2 FHIR Std.
Procedure.code.coding:VerrichtingTypeCodelijst Base required VerrichtingTypeCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3

Constraints

Id Grade Path(s) Description Expression
dom-1 error Procedure If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pro-1 error Procedure Reason not done is only permitted if notDone indicator is true notDoneReason.empty() or notDone = true

Differential View

This structure is derived from Zib Procedure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Zib Procedure(2.1.12) Procedure
... code 1..1 CodeableConcept ProcedureType
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... 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: 713603004
... subject 1..1 Reference(Patient(1.0.0-rc1)) Who the procedure was performed on
... context 0..1 Reference(Encounter(1.0.0-rc1)) Encounter or episode associated with the procedure
.... actor 1..1 Reference(HealthProfessional Practitioner(1.0.0-rc1)) The reference to the practitioner

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure C 0..* Zib Procedure(2.1.12) Procedure
Constraints: pro-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 resource content
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... 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
... Slices for extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... extension:procedureMethod 0..1 (Complex) The method used to perform the procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-method
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/procedure-method"
..... Slices for valueCodeableConcept Content/Rules for all slices
...... valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept ProcedureMethod
Binding: VerrichtingMethodeCodelijst (2017-12-31T00:00:00) (extensible): VerrichtingMethodeCodelijst
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Identifiers for this procedure
... definition Σ 0..* Reference(PlanDefinition | ActivityDefinition | HealthcareService) Instantiates protocol or definition
... Slices for basedOn Σ 0..* Reference(CarePlan | ProcedureRequest | ReferralRequest) A request for this procedure
Slice: Unordered, Open by type:$this.resolve()
.... basedOn:request Σ 0..* Reference(HCIM ProcedureRequest(2.1.9)) ProcedureRequest
... partOf Σ 0..* Reference(Procedure | Observation | MedicationAdministration) Part of referenced event
... status ?!Σ 1..1 code preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.
... notDone ?!Σ 0..1 boolean True if procedure was not performed as scheduled
... notDoneReason ΣC 0..1 CodeableConcept Reason procedure was not performed
Binding: Procedure Not Performed Reason (SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.
... category Σ 1..1 CodeableConcept Classification of the procedure
Binding: Procedure Category Codes (SNOMED CT) (example): A code that classifies a procedure for searching, sorting and display purposes.
Example Example of category code: {"coding":[{"system":"http://snomed.info/sct","code":"387713003","display":"Surgical procedure"}]}
... code Σ 1..1 CodeableConcept ProcedureType
Binding: Procedure Codes (SNOMED CT) (example): A code to identify a specific procedure .
Required Pattern: At least the following
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string xml:id (or equivalent in JSON)
..... 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: 713603004
..... 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
.... id 0..1 string xml:id (or equivalent in JSON)
.... 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:system
..... coding:VerrichtingTypeCodelijst Σ 0..* Coding ProcedureType
Binding: VerrichtingTypeCodelijst (2017-12-31T00:00:00) (required): The name of the procedure using the Verrichtingenthesaurus DHD.
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... 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 Σ 0..1 code Symbol in syntax defined by the system
...... 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
... subject Σ 1..1 Reference(Patient(1.0.0-rc1)) Who the procedure was performed on
... context Σ 0..1 Reference(Encounter(1.0.0-rc1)) Encounter or episode associated with the procedure
... Slices for performed[x] Σ 0..1 Date/Period the procedure was performed
Slice: Unordered, Open by type:$this
.... performedDateTime dateTime
.... performedPeriod Period
.... performed[x]:performedPeriod Σ 0..1 Period Date/Period the procedure was performed
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime ProcedureStartDate
..... end ΣC 0..1 dateTime ProcedureEndDate
... performer Σ 0..* BackboneElement HealthProfessional | Location::HealthcareProvider
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... role Σ 0..1 CodeableConcept The role the actor was in
Binding: Procedure Performer Role Codes (example): A code that identifies the role of a performer of the procedure.
..... id 0..1 string xml:id (or equivalent in JSON)
..... 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:healthProfessionalRole Σ 0..* Coding HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (2017-12-31T00:00:00) (required)
..... text Σ 0..1 string Plain text representation of the concept
.... actor Σ 1..1 Reference(HealthProfessional Practitioner(1.0.0-rc1)) The reference to the practitioner
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... extension:practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... 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: Procedure Reason Codes (example): A code that identifies the reason a procedure is required.
... reasonReference Σ 0..* Reference(HCIM Problem(3.0.7)) Indication
... bodySite Σ 0..* CodeableConcept ProcedureAnatomicalLocation
Binding: VerrichtingAnatomischeLocatieCodelijst (2017-12-31T00:00:00) (extensible): Anatomical location which is the focus of the procedure.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... extension:ProcedureLaterality 0..1 (Complex) ProcedureLaterality
URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier
Constraints: ext-1
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..0 Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier"
...... value[x] 0..1 CodeableConcept BodySite qualifier
Binding: VerrichtingLateraliteitCodelijst (2017-12-31T00:00:00) (extensible): ProcedureLateralityCodelist
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... outcome Σ 0..1 CodeableConcept The result of procedure
Binding: Procedure Outcome Codes (SNOMED CT) (example): An outcome of a procedure - whether it was resolved or otherwise.
... Slices for report 0..* Reference(DiagnosticReport) Any report resulting from the procedure
Slice: Unordered, Open by profile:resolve()
.... report:textResult 0..* Reference(HCIM TextResult(2.1.4)) Any report resulting from the procedure
... complication 0..* CodeableConcept Complication following the procedure
Binding: Condition/Problem/Diagnosis Codes (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: Procedure Follow up Codes (SNOMED CT) (example): Specific follow up required for a procedure e.g. removal of sutures.
... note 0..* Annotation Additional information about the procedure
... focalDevice 0..* BackboneElement Device changed in procedure
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... action 0..1 CodeableConcept Kind of change to device
Binding: Procedure Device Action Codes (preferred): A kind of change that happened to the device during the procedure.
.... manipulated 1..1 Reference(HCIM MedicalDevice Product(2.0.6)) MedicalDevice
... usedReference 0..* Reference(Device | Medication | Substance) Items used during procedure
... usedCode 0..* CodeableConcept Coded items used during the procedure
Binding: FHIR Device Types (example): Codes describing items used during a procedure

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Procedure.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Procedure.extension:procedureMethod.​valueCodeableConcept:valueCodeableConcept Base extensible VerrichtingMethodeCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Procedure.status Base required EventStatus 📍3.0.2 FHIR Std.
Procedure.notDoneReason Base example Procedure Not Performed Reason (SNOMED-CT) 📍3.0.2 FHIR Std.
Procedure.category Base example Procedure Category Codes (SNOMED CT) 📍3.0.2 FHIR Std.
Procedure.code Base example Procedure Codes (SNOMED CT) 📍3.0.2 FHIR Std.
Procedure.code.coding:VerrichtingTypeCodelijst Base required VerrichtingTypeCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Procedure.performer.​role Base example Procedure Performer Role Codes 📍3.0.2 FHIR Std.
Procedure.performer.​role.coding:healthProfessionalRole Base required ZorgverlenerRolCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Procedure.reasonCode Base example Procedure Reason Codes 📍3.0.2 FHIR Std.
Procedure.bodySite Base extensible VerrichtingAnatomischeLocatieCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Procedure.bodySite.extension:ProcedureLaterality.​value[x] Base extensible VerrichtingLateraliteitCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Procedure.outcome Base example Procedure Outcome Codes (SNOMED CT) 📍3.0.2 FHIR Std.
Procedure.complication Base example Condition/Problem/Diagnosis Codes 📍3.0.2 FHIR Std.
Procedure.followUp Base example Procedure Follow up Codes (SNOMED CT) 📍3.0.2 FHIR Std.
Procedure.focalDevice.​action Base preferred Procedure Device Action Codes 📍3.0.2 FHIR Std.
Procedure.usedCode Base example FHIR Device Types 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Procedure If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ext-1 error Procedure.performer.actor.extension:practitionerRole, Procedure.bodySite.extension:ProcedureLaterality Must have either extensions or value[x], not both extension.exists() != value.exists()
pro-1 error Procedure Reason not done is only permitted if notDone indicator is true notDoneReason.empty() or notDone = true

 

Other representations of profile: CSV, Excel, Schematron