1.0.0 - release

CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ProcedureKVALite

Official URL: https://fhir.cambio.se/StructureDefinition/ProcedureKVALite/v1 Version:
Active as of 2021-09-22 Computable Name: ProcedureKVALite

Introduction

ProcedureKVALite is a profile intended to be used by the Swedish market, and handles codes from the code system KVÅ. This profile is based on the FHIR resource Procedure. Additionally, it manages building hierarchies of procedures with the extension {{link:https://fhir.cambio.se/StructureDefinition/common-subProcedure/v1}}.

Intended Use

ProcedureKVALite is currently only used as a contained resource within QuestionnaireResponse.

Intended user for this resource is only a healthcare professional. The healthcare professional should be the same as specified in QuestionnaireResponseSe. If Unit is specified, it should be with HSA id and has to be the same unit as was given in QuestionnaireResponseSe.

Specific Rules and Limitations

Type Description
Rule The author of ProcedureKVALite should not be a patient.
Rule The API should not be used to send unsigned data to COSMIC.

Versions

COS version Profile version Required COSMIC version Date Description
4.1.0 1.0.0 R8.3.05 Sep 2021 Initial version

Statuses

FHIR status Interpretation
preparation Considered a future/planned procedure. E.g. status cannot be preparation if performedDateTime is in the past.
completed Considered a completed procedure. E.g. status cannot be completed if performedDateTime is in the future.

APIs & Supported Operations

Not applicable, this profile is just used as a contained resource and there is no API for Procedure. For examples, refer to Resources.QuestionnaireResponse.

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 0..* ProcedureCoreSe An action that is being or was performed on a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:subProcedure 0..* Reference(ProcedureKVALite) Extension
URL: https://fhir.cambio.se/StructureDefinition/common-subProcedure/v1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code Σ 1..1 CodeableConcept Identification of the procedure
Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .
.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:1.2.752.116.1.3.2.1.4
..... code Σ 1..1 code Symbol in syntax defined by the system
... subject Σ 1..1 Reference(Patient) Who the procedure was performed on
... performed[x] Σ 1..1 dateTime When the procedure was performed
... recorder Σ 0..1 Reference(PractitionerRoleLiteSe) Who recorded the procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
From the FHIR Standard
Procedure.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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 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-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()
dom-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ProcedureCoreSe

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* ProcedureCoreSe An action that is being or was performed on a patient
... meta
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:subProcedure 0..* Reference(ProcedureKVALite) Extension
URL: https://fhir.cambio.se/StructureDefinition/common-subProcedure/v1
... identifier 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..0
... partOf 0..0
... status 1..1 code preparation | completed
... statusReason 0..0
... category 0..0
... code 1..1 CodeableConcept Identification of the procedure
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:1.2.752.116.1.3.2.1.4
..... code 1..1 code Symbol in syntax defined by the system
... subject 1..1 Reference(Patient) Who the procedure was performed on
... performed[x] 1..1 dateTime When the procedure was performed
... recorder 0..1 Reference(PractitionerRoleLiteSe) Who recorded the procedure
... asserter 0..0
... performer 0..0
... location 0..0
... reasonCode 0..0
... reasonReference 0..0
... bodySite 0..0
... outcome 0..0
... report 0..0
... complication 0..0
... complicationDetail 0..0
... followUp 0..0
... note 0..0
... focalDevice 0..0
... usedReference 0..0
... usedCode 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* ProcedureCoreSe An action that is being or was performed on a patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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 Extension
Slice: Unordered, Open by value:url
.... extension:subProcedure 0..* Reference(ProcedureKVALite) Extension
URL: https://fhir.cambio.se/StructureDefinition/common-subProcedure/v1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code preparation | completed
Binding: EventStatus (required): A code specifying the state of the procedure.
... code Σ 1..1 CodeableConcept Identification of the procedure
Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... 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: urn:oid:1.2.752.116.1.3.2.1.4
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..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) Who the procedure was performed on
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... performed[x] Σ 1..1 dateTime When the procedure was performed
... recorder Σ 0..1 Reference(PractitionerRoleLiteSe) Who recorded the procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Procedure.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Procedure.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
From the FHIR Standard
Procedure.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
Procedure.performer.functionexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
From the FHIR Standard
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
http://hl7.org/fhir/ValueSet/device-action
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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 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-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()
dom-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ProcedureCoreSe

Summary

Mandatory: 5 elements(1 nested mandatory element)
Fixed: 1 element
Prohibited: 22 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* ProcedureCoreSe An action that is being or was performed on a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:subProcedure 0..* Reference(ProcedureKVALite) Extension
URL: https://fhir.cambio.se/StructureDefinition/common-subProcedure/v1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code Σ 1..1 CodeableConcept Identification of the procedure
Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .
.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:1.2.752.116.1.3.2.1.4
..... code Σ 1..1 code Symbol in syntax defined by the system
... subject Σ 1..1 Reference(Patient) Who the procedure was performed on
... performed[x] Σ 1..1 dateTime When the procedure was performed
... recorder Σ 0..1 Reference(PractitionerRoleLiteSe) Who recorded the procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
From the FHIR Standard
Procedure.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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 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-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()
dom-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from ProcedureCoreSe

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* ProcedureCoreSe An action that is being or was performed on a patient
... meta
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:subProcedure 0..* Reference(ProcedureKVALite) Extension
URL: https://fhir.cambio.se/StructureDefinition/common-subProcedure/v1
... identifier 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..0
... partOf 0..0
... status 1..1 code preparation | completed
... statusReason 0..0
... category 0..0
... code 1..1 CodeableConcept Identification of the procedure
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:1.2.752.116.1.3.2.1.4
..... code 1..1 code Symbol in syntax defined by the system
... subject 1..1 Reference(Patient) Who the procedure was performed on
... performed[x] 1..1 dateTime When the procedure was performed
... recorder 0..1 Reference(PractitionerRoleLiteSe) Who recorded the procedure
... asserter 0..0
... performer 0..0
... location 0..0
... reasonCode 0..0
... reasonReference 0..0
... bodySite 0..0
... outcome 0..0
... report 0..0
... complication 0..0
... complicationDetail 0..0
... followUp 0..0
... note 0..0
... focalDevice 0..0
... usedReference 0..0
... usedCode 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* ProcedureCoreSe An action that is being or was performed on a patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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 Extension
Slice: Unordered, Open by value:url
.... extension:subProcedure 0..* Reference(ProcedureKVALite) Extension
URL: https://fhir.cambio.se/StructureDefinition/common-subProcedure/v1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code preparation | completed
Binding: EventStatus (required): A code specifying the state of the procedure.
... code Σ 1..1 CodeableConcept Identification of the procedure
Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... 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: urn:oid:1.2.752.116.1.3.2.1.4
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..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) Who the procedure was performed on
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... performed[x] Σ 1..1 dateTime When the procedure was performed
... recorder Σ 0..1 Reference(PractitionerRoleLiteSe) Who recorded the procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Procedure.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Procedure.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
From the FHIR Standard
Procedure.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
Procedure.performer.functionexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
From the FHIR Standard
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
http://hl7.org/fhir/ValueSet/device-action
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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 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-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()
dom-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ProcedureCoreSe

Summary

Mandatory: 5 elements(1 nested mandatory element)
Fixed: 1 element
Prohibited: 22 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron