RIVO-Noord Zorgviewer Implementation Guide
0.26.0 - sprint33 Netherlands flag

RIVO-Noord Zorgviewer Implementation Guide - Local Development build (v0.26.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Procedure

Official URL: http://hl7.nl/fhir/zorgviewer/StructureDefinition/Procedure Version: 0.26.0
Draft as of 2024-06-07 Computable Name: Procedure

Verrichtingen

Dit Profiel is het resultaat van de vergelijking tussen de zib2017 FHIR Profiel en de implementaties in Epic en Chipsoft. De elementen die in ieder geval in alle output beschikbaar zullen zijn. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.

Zorginformatiebouwsteen

ZIB Verrichting

User-Interface guidance

Een schets van het scherm met labels en sortering informatie

Kolom definities:

Kolom label FHIR Path FHIR Type Zib element Toelichting of regels
Bron .meta.extension[system="http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source"].valueUri string nvt Lookup adhv uri (AGB-Z of OID) <adressering-base>/Organization?identifier=<.meta.tag.code> en gebruik dan Organization.name
Datum .performedPeriod.start​ dateTime VerrichtingBeginDatum ​Kunnen vage datums zijn.​
Verrichting .code.text string​ VerrichtingType
Locatie .location.display​ string Locatie::Zorgaanbieder Zie discussie hier: BITS ticket MM-5002
Uitgevoerd door .performer.actor.display​ string Uitvoerder Meestal alleen specialisme
(1) UITKLAPVELD
Verrichtingcode .code.coding[] en dan .system, .code en .display​ string VerrichtingType Meerdere codes mogelijk.
Ignore NullFlavor.​
Lookup system label middels <terminologie-base>/CodeSystem?url=<.system> en gebruik dan CodeSystem.title
Lateraliteit .bodySite.extension[url="http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier"].valueCodeableConcept.text string ProbleemLateraliteit

Zoeken naar codes

Request

  1. Opvragen (search) verrichtingen

    GET <ontsluiten-bronsysteem-base>/Procedure?patient=<fhir_patient_id>

    N.B. Deze request is breder dan de BgZ request, waar alleen de chirugische verrichtingen worden opgevraagd.

Bronsysteem herkennen

De Zorgviewer-backend of Ontsluiten bronsysteem MOET na bevragen van het bronsysteem aan elk resultaat resource een meta-tag toevoegen met de VEKTIS AGB-Z code of de HL7 NL OID van de zorgaanbieder. Dit wordt vervolgens gebruikt in de “Bron” kolom in de Zorgviewer-frontend. N.B. We gebruiken hier een pre-adopt van de FHIR R4 Meta.source.

Toevoegen aan elke response, dus per resource (bij een read) of per Bundle (bij een search):

"meta": {
    "extension": [ {
        "url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source",
        "valueUri": "urn:oid:2.16.840.1.113883.2.4.3.8"
    } ]
}

Optioneel: Elke entry van een search response Bundle bevat een referentie naar de bijbehorende Patient (<resource>.subject|patient). Elke patient heeft een Patient.managingOrganization en in de gerefereerde Organization.identifier staat vervolgens o.a. de OID van het bronsysyeem. Of je gebruikt de identifiers om een volledige Organization op te zoeken in het adresboek en zie inhoud hier.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Zib Procedure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Zib Procedure Procedure
... code 0..1 CodeableConcept ProcedureType
.... text S 0..1 string Plain text representation of the concept
... performedPeriod S 0..1 Period Date/Period the procedure was performed
... performer 0..* BackboneElement HealthProfessional | Location::HealthcareProvider
.... actor 1..1 Reference(nl-core-practitioner | nl-core-organization) The reference to the practitioner
..... display S 0..1 string Text alternative for the resource
.... display S 0..1 string Text alternative for the resource
... bodySite
.... extension S 0..* Extension Extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure C 0..* Zib Procedure Procedure
pro-1: Reason not done is only permitted if notDone indicator is true
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... 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 (extensible): VerrichtingMethodeCodelijst

... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... basedOn:request Σ 0..* Reference(HCIM ProcedureRequest) 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 Σ 0..1 CodeableConcept ProcedureType
Binding: Procedure Codes (SNOMED CT) (example): A code to identify a specific procedure .

.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:VerrichtingTypeCodelijst Σ 0..* Coding ProcedureType
Binding: VerrichtingTypeCodelijst (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
.... text SΣ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(Group | nl-core-patient) Who the procedure was performed on
... Slices for performed[x] Σ 0..1 Period Date/Period the procedure was performed
Slice: Unordered, Closed by type:$this
.... performed[x]:performedPeriod SΣ 0..1 Period Date/Period the procedure was performed
... performer Σ 0..* BackboneElement HealthProfessional | Location::HealthcareProvider
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... actor Σ 1..1 Reference(nl-core-practitioner | nl-core-organization) The reference to the practitioner
..... Slices for extension Content/Rules for all slices
...... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
..... display SΣ 0..1 string Text alternative for the resource
... location Σ 0..1 Reference(Location) Where the procedure happened
.... display SΣ 0..1 string Text alternative for the resource
... bodySite Σ 0..* CodeableConcept ProcedureAnatomicalLocation
Binding: VerrichtingAnatomischeLocatieCodelijst (extensible): Anatomical location which is the focus of the procedure.


.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... ProcedureLaterality 0..1 (Complex) ProcedureLaterality
URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier"
...... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1 CodeableConcept BodySite qualifier
Binding: VerrichtingLateraliteitCodelijst (extensible): ProcedureLateralityCodelist


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.extension:procedureMethod.valueCodeableConcept:valueCodeableConceptextensibleVerrichtingMethodeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.4--20171231000000
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status
from the FHIR Standard
Procedure.categoryexampleProcedure Category Codes (SNOMED CT)
http://hl7.org/fhir/ValueSet/procedure-category
from the FHIR Standard
Procedure.codeexampleProcedure Codes (SNOMED CT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
Procedure.code.coding:VerrichtingTypeCodelijstrequiredVerrichtingTypeCodelijst (a valid code from SNOMED CT)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.2--20171231000000
Procedure.bodySiteextensibleVerrichtingAnatomischeLocatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.1--20171231000000
Procedure.bodySite.extension:ProcedureLaterality.value[x]:valueCodeableConceptextensibleVerrichtingLateraliteitCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.3--20171231000000

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorProcedureIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf 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-4errorProcedureIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pro-1errorProcedureReason not done is only permitted if notDone indicator is true
: notDoneReason.empty() or notDone = true
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure C 0..* Zib Procedure Procedure
pro-1: Reason not done is only permitted if notDone indicator is true
... 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
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... 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 (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) 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 Σ 0..1 CodeableConcept ProcedureType
Binding: Procedure Codes (SNOMED CT) (example): A code to identify a specific 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:system
..... coding:VerrichtingTypeCodelijst Σ 0..* Coding ProcedureType
Binding: VerrichtingTypeCodelijst (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 SΣ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(Group | nl-core-patient) Who the procedure was performed on
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or episode associated with the procedure
... Slices for performed[x] Σ 0..1 Period Date/Period the procedure was performed
Slice: Unordered, Closed by type:$this
.... performed[x]:performedPeriod SΣ 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 (required)
..... text Σ 0..1 string Plain text representation of the concept
.... actor Σ 1..1 Reference(nl-core-practitioner | nl-core-organization) The reference to the practitioner
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
..... 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 SΣ 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
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... 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 SΣ 0..1 string Text alternative for the resource
... 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) Indication
... bodySite Σ 0..* CodeableConcept ProcedureAnatomicalLocation
Binding: VerrichtingAnatomischeLocatieCodelijst (extensible): Anatomical location which is the focus of the procedure.


.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... ProcedureLaterality 0..1 (Complex) ProcedureLaterality
URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier
...... 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://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier"
...... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1 CodeableConcept BodySite qualifier
Binding: VerrichtingLateraliteitCodelijst (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.

... report 0..* Reference(HCIM TextResult) 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) 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

PathConformanceValueSetURI
Procedure.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Procedure.extension:procedureMethod.valueCodeableConcept:valueCodeableConceptextensibleVerrichtingMethodeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.4--20171231000000
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status
from the FHIR Standard
Procedure.notDoneReasonexampleProcedure Not Performed Reason (SNOMED-CT)
http://hl7.org/fhir/ValueSet/procedure-not-performed-reason
from the FHIR Standard
Procedure.categoryexampleProcedure Category Codes (SNOMED CT)
http://hl7.org/fhir/ValueSet/procedure-category
from the FHIR Standard
Procedure.codeexampleProcedure Codes (SNOMED CT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
Procedure.code.coding:VerrichtingTypeCodelijstrequiredVerrichtingTypeCodelijst (a valid code from SNOMED CT)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.2--20171231000000
Procedure.performer.roleexampleProcedure Performer Role Codes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
Procedure.performer.role.coding:healthProfessionalRolerequiredZorgverlenerRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000
Procedure.reasonCodeexampleProcedure Reason Codes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
Procedure.bodySiteextensibleVerrichtingAnatomischeLocatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.1--20171231000000
Procedure.bodySite.extension:ProcedureLaterality.value[x]:valueCodeableConceptextensibleVerrichtingLateraliteitCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.3--20171231000000
Procedure.outcomeexampleProcedure Outcome Codes (SNOMED CT)
http://hl7.org/fhir/ValueSet/procedure-outcome
from the FHIR Standard
Procedure.complicationexampleCondition/Problem/Diagnosis Codes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
Procedure.followUpexampleProcedure Follow up Codes (SNOMED CT)
http://hl7.org/fhir/ValueSet/procedure-followup
from the FHIR Standard
Procedure.focalDevice.actionpreferredProcedure Device Action Codes
http://hl7.org/fhir/ValueSet/device-action
from the FHIR Standard
Procedure.usedCodeexampleFHIR Device Types
http://hl7.org/fhir/ValueSet/device-kind
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorProcedureIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf 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-4errorProcedureIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pro-1errorProcedureReason not done is only permitted if notDone indicator is true
: notDoneReason.empty() or notDone = true

This structure is derived from Zib Procedure

Summary

Must-Support: 5 elements

Differential View

This structure is derived from Zib Procedure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Zib Procedure Procedure
... code 0..1 CodeableConcept ProcedureType
.... text S 0..1 string Plain text representation of the concept
... performedPeriod S 0..1 Period Date/Period the procedure was performed
... performer 0..* BackboneElement HealthProfessional | Location::HealthcareProvider
.... actor 1..1 Reference(nl-core-practitioner | nl-core-organization) The reference to the practitioner
..... display S 0..1 string Text alternative for the resource
.... display S 0..1 string Text alternative for the resource
... bodySite
.... extension S 0..* Extension Extension

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure C 0..* Zib Procedure Procedure
pro-1: Reason not done is only permitted if notDone indicator is true
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... 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 (extensible): VerrichtingMethodeCodelijst

... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... basedOn:request Σ 0..* Reference(HCIM ProcedureRequest) 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 Σ 0..1 CodeableConcept ProcedureType
Binding: Procedure Codes (SNOMED CT) (example): A code to identify a specific procedure .

.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:VerrichtingTypeCodelijst Σ 0..* Coding ProcedureType
Binding: VerrichtingTypeCodelijst (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
.... text SΣ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(Group | nl-core-patient) Who the procedure was performed on
... Slices for performed[x] Σ 0..1 Period Date/Period the procedure was performed
Slice: Unordered, Closed by type:$this
.... performed[x]:performedPeriod SΣ 0..1 Period Date/Period the procedure was performed
... performer Σ 0..* BackboneElement HealthProfessional | Location::HealthcareProvider
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... actor Σ 1..1 Reference(nl-core-practitioner | nl-core-organization) The reference to the practitioner
..... Slices for extension Content/Rules for all slices
...... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
..... display SΣ 0..1 string Text alternative for the resource
... location Σ 0..1 Reference(Location) Where the procedure happened
.... display SΣ 0..1 string Text alternative for the resource
... bodySite Σ 0..* CodeableConcept ProcedureAnatomicalLocation
Binding: VerrichtingAnatomischeLocatieCodelijst (extensible): Anatomical location which is the focus of the procedure.


.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... ProcedureLaterality 0..1 (Complex) ProcedureLaterality
URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier"
...... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1 CodeableConcept BodySite qualifier
Binding: VerrichtingLateraliteitCodelijst (extensible): ProcedureLateralityCodelist


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.extension:procedureMethod.valueCodeableConcept:valueCodeableConceptextensibleVerrichtingMethodeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.4--20171231000000
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status
from the FHIR Standard
Procedure.categoryexampleProcedure Category Codes (SNOMED CT)
http://hl7.org/fhir/ValueSet/procedure-category
from the FHIR Standard
Procedure.codeexampleProcedure Codes (SNOMED CT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
Procedure.code.coding:VerrichtingTypeCodelijstrequiredVerrichtingTypeCodelijst (a valid code from SNOMED CT)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.2--20171231000000
Procedure.bodySiteextensibleVerrichtingAnatomischeLocatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.1--20171231000000
Procedure.bodySite.extension:ProcedureLaterality.value[x]:valueCodeableConceptextensibleVerrichtingLateraliteitCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.3--20171231000000

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorProcedureIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf 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-4errorProcedureIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pro-1errorProcedureReason not done is only permitted if notDone indicator is true
: notDoneReason.empty() or notDone = true

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure C 0..* Zib Procedure Procedure
pro-1: Reason not done is only permitted if notDone indicator is true
... 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
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... 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 (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) 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 Σ 0..1 CodeableConcept ProcedureType
Binding: Procedure Codes (SNOMED CT) (example): A code to identify a specific 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:system
..... coding:VerrichtingTypeCodelijst Σ 0..* Coding ProcedureType
Binding: VerrichtingTypeCodelijst (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 SΣ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(Group | nl-core-patient) Who the procedure was performed on
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or episode associated with the procedure
... Slices for performed[x] Σ 0..1 Period Date/Period the procedure was performed
Slice: Unordered, Closed by type:$this
.... performed[x]:performedPeriod SΣ 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 (required)
..... text Σ 0..1 string Plain text representation of the concept
.... actor Σ 1..1 Reference(nl-core-practitioner | nl-core-organization) The reference to the practitioner
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
..... 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 SΣ 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
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... 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 SΣ 0..1 string Text alternative for the resource
... 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) Indication
... bodySite Σ 0..* CodeableConcept ProcedureAnatomicalLocation
Binding: VerrichtingAnatomischeLocatieCodelijst (extensible): Anatomical location which is the focus of the procedure.


.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... ProcedureLaterality 0..1 (Complex) ProcedureLaterality
URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier
...... 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://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier"
...... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1 CodeableConcept BodySite qualifier
Binding: VerrichtingLateraliteitCodelijst (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.

... report 0..* Reference(HCIM TextResult) 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) 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

PathConformanceValueSetURI
Procedure.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Procedure.extension:procedureMethod.valueCodeableConcept:valueCodeableConceptextensibleVerrichtingMethodeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.4--20171231000000
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status
from the FHIR Standard
Procedure.notDoneReasonexampleProcedure Not Performed Reason (SNOMED-CT)
http://hl7.org/fhir/ValueSet/procedure-not-performed-reason
from the FHIR Standard
Procedure.categoryexampleProcedure Category Codes (SNOMED CT)
http://hl7.org/fhir/ValueSet/procedure-category
from the FHIR Standard
Procedure.codeexampleProcedure Codes (SNOMED CT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
Procedure.code.coding:VerrichtingTypeCodelijstrequiredVerrichtingTypeCodelijst (a valid code from SNOMED CT)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.2--20171231000000
Procedure.performer.roleexampleProcedure Performer Role Codes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
Procedure.performer.role.coding:healthProfessionalRolerequiredZorgverlenerRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000
Procedure.reasonCodeexampleProcedure Reason Codes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
Procedure.bodySiteextensibleVerrichtingAnatomischeLocatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.1--20171231000000
Procedure.bodySite.extension:ProcedureLaterality.value[x]:valueCodeableConceptextensibleVerrichtingLateraliteitCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.1.3--20171231000000
Procedure.outcomeexampleProcedure Outcome Codes (SNOMED CT)
http://hl7.org/fhir/ValueSet/procedure-outcome
from the FHIR Standard
Procedure.complicationexampleCondition/Problem/Diagnosis Codes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
Procedure.followUpexampleProcedure Follow up Codes (SNOMED CT)
http://hl7.org/fhir/ValueSet/procedure-followup
from the FHIR Standard
Procedure.focalDevice.actionpreferredProcedure Device Action Codes
http://hl7.org/fhir/ValueSet/device-action
from the FHIR Standard
Procedure.usedCodeexampleFHIR Device Types
http://hl7.org/fhir/ValueSet/device-kind
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorProcedureIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf 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-4errorProcedureIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pro-1errorProcedureReason not done is only permitted if notDone indicator is true
: notDoneReason.empty() or notDone = true

This structure is derived from Zib Procedure

Summary

Must-Support: 5 elements

 

Other representations of profile: CSV, Excel, Schematron