PanCareSurPass Project HL7 FHIR Implementation Guide
0.2.0 - CI Build 150

PanCareSurPass Project HL7 FHIR Implementation Guide, published by PanCareSurPass Project. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/pcsp/ and changes regularly. See the Directory of published versions

Resource Profile: Procedure: SCT Prophylaxis

Official URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/Procedure-sct-prophylaxis-eu-pcsp Version: 0.2.0
Draft as of 2024-12-11 Computable Name: ProcedureSctProphylaxisPcsp

This profile defines how to represent GVHD prophylaxis, conditioning regimen Procedures in FHIR for supporting Stem Cell Transplantation data, as required by the PanCareSurPass algorithm to generate the care plan.

Usage:

Formal Views of Profile Content

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

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure Procedure
... identifier 0..* Identifier External Identifiers for this SCT-related procedure
... status S 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... category 1..1 CodeableConcept Classification of the procedure
Binding: SCT Prophylaxis Cathegory (required)
... subject 1..1 Reference(Patient: PCSP) Who the procedure was performed on
... Slices for performed[x] 0..1 dateTime, Period, string, Age, Range When the procedure was performed
Slice: Unordered, Open by type:$this
.... performed[x]:performedPeriod S 0..1 Period When the procedure was performed
... reasonReference S 2..* Reference(Condition: Primary Cancer | Procedure: Stem Cell Transplantation) The justification that the procedure was performed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Procedure.categoryrequiredSctProphylaxisCathegory
http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-sct-prophylaxis-cathegory-eu-pcsp
from this IG
Procedure.codeextensibleSctProphylaxisType
http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-sct-prophylaxis-type-eu-pcsp
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure An action that is being or was performed on a patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 0..* Identifier External Identifiers for this SCT-related procedure
ele-1: All FHIR elements must have a @value or children
... category Σ 1..1 CodeableConcept Classification of the procedure
Binding: SCT Prophylaxis Cathegory (required)
ele-1: All FHIR elements must have a @value or children
... code Σ 0..1 CodeableConcept Identification of the procedure
Binding: SCT Prophylaxis Type (extensible)
ele-1: All FHIR elements must have a @value or children
... subject Σ 1..1 Reference(Patient: PCSP) Who the procedure was performed on
ele-1: All FHIR elements must have a @value or children
... Slices for performed[x] Σ 0..1 When the procedure was performed
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... performedDateTime dateTime
.... performedPeriod Period
.... performedString string
.... performedAge Age
.... performedRange Range
.... performed[x]:performedPeriod SΣ 0..1 Period When the procedure was performed
ele-1: All FHIR elements must have a @value or children
... reasonReference SΣ 2..* Reference(Condition: Primary Cancer | Procedure: Stem Cell Transplantation) The justification that the procedure was performed
ele-1: All FHIR elements must have a @value or children

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.categoryrequiredSctProphylaxisCathegory
http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-sct-prophylaxis-cathegory-eu-pcsp
from this IG
Procedure.codeextensibleSctProphylaxisType
http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-sct-prophylaxis-type-eu-pcsp
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Identifiers for this SCT-related procedure
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest) A request for this procedure
... partOf Σ 0..* Reference(Procedure | Observation | MedicationAdministration) Part of referenced event
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.

... statusReason Σ 0..1 CodeableConcept Reason for current status
Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.

... category Σ 1..1 CodeableConcept Classification of the procedure
Binding: SCT Prophylaxis Cathegory (required)
... code Σ 0..1 CodeableConcept Identification of the procedure
Binding: SCT Prophylaxis Type (extensible)
... subject Σ 1..1 Reference(Patient: PCSP) Who the procedure was performed on
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... Slices for performed[x] Σ 0..1 When the procedure was performed
Slice: Unordered, Open by type:$this
.... performedDateTime dateTime
.... performedPeriod Period
.... performedString string
.... performedAge Age
.... performedRange Range
.... performed[x]:performedPeriod SΣ 0..1 Period When the procedure was performed
... recorder Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who recorded the procedure
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Person who asserts this procedure
... performer Σ 0..* BackboneElement The people who performed the procedure
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function Σ 0..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.

.... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) The reference to the practitioner
.... 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: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.


... reasonReference SΣ 2..* Reference(Condition: Primary Cancer | Procedure: Stem Cell Transplantation) The justification that the procedure was performed
... bodySite Σ 0..* CodeableConcept Target body sites
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... outcome Σ 0..1 CodeableConcept The result of procedure
Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.

... report 0..* Reference(DiagnosticReport | DocumentReference | Composition) Any report resulting from the procedure
... complication 0..* CodeableConcept Complication following the procedure
Binding: Condition/Problem/DiagnosisCodes (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: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures.


... note 0..* Annotation Additional information about the procedure
... focalDevice 0..* BackboneElement Manipulated, implanted, or removed device
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... action 0..1 CodeableConcept Kind of change to device
Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure.

.... manipulated 1..1 Reference(Device) Device that was changed
... usedReference 0..* Reference(Device | Medication | Substance) Items used during procedure
... usedCode 0..* CodeableConcept Coded items used during the procedure
Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
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.statusReasonexampleProcedureNotPerformedReason(SNOMED-CT)
http://hl7.org/fhir/ValueSet/procedure-not-performed-reason
from the FHIR Standard
Procedure.categoryrequiredSctProphylaxisCathegory
http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-sct-prophylaxis-cathegory-eu-pcsp
from this IG
Procedure.codeextensibleSctProphylaxisType
http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-sct-prophylaxis-type-eu-pcsp
from this IG
Procedure.performer.functionexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
Procedure.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
Procedure.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Procedure.outcomeexampleProcedureOutcomeCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-outcome
from the FHIR Standard
Procedure.complicationexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
Procedure.followUpexampleProcedureFollowUpCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-followup
from the FHIR Standard
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
http://hl7.org/fhir/ValueSet/device-action
from the FHIR Standard
Procedure.usedCodeexampleFHIRDeviceTypes
http://hl7.org/fhir/ValueSet/device-kind
from the FHIR Standard

This structure is derived from Procedure

Summary

Mandatory: 1 element
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Procedure.performed[x]

Differential View

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure Procedure
... identifier 0..* Identifier External Identifiers for this SCT-related procedure
... status S 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... category 1..1 CodeableConcept Classification of the procedure
Binding: SCT Prophylaxis Cathegory (required)
... subject 1..1 Reference(Patient: PCSP) Who the procedure was performed on
... Slices for performed[x] 0..1 dateTime, Period, string, Age, Range When the procedure was performed
Slice: Unordered, Open by type:$this
.... performed[x]:performedPeriod S 0..1 Period When the procedure was performed
... reasonReference S 2..* Reference(Condition: Primary Cancer | Procedure: Stem Cell Transplantation) The justification that the procedure was performed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Procedure.categoryrequiredSctProphylaxisCathegory
http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-sct-prophylaxis-cathegory-eu-pcsp
from this IG
Procedure.codeextensibleSctProphylaxisType
http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-sct-prophylaxis-type-eu-pcsp
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure An action that is being or was performed on a patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 0..* Identifier External Identifiers for this SCT-related procedure
ele-1: All FHIR elements must have a @value or children
... category Σ 1..1 CodeableConcept Classification of the procedure
Binding: SCT Prophylaxis Cathegory (required)
ele-1: All FHIR elements must have a @value or children
... code Σ 0..1 CodeableConcept Identification of the procedure
Binding: SCT Prophylaxis Type (extensible)
ele-1: All FHIR elements must have a @value or children
... subject Σ 1..1 Reference(Patient: PCSP) Who the procedure was performed on
ele-1: All FHIR elements must have a @value or children
... Slices for performed[x] Σ 0..1 When the procedure was performed
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... performedDateTime dateTime
.... performedPeriod Period
.... performedString string
.... performedAge Age
.... performedRange Range
.... performed[x]:performedPeriod SΣ 0..1 Period When the procedure was performed
ele-1: All FHIR elements must have a @value or children
... reasonReference SΣ 2..* Reference(Condition: Primary Cancer | Procedure: Stem Cell Transplantation) The justification that the procedure was performed
ele-1: All FHIR elements must have a @value or children

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.categoryrequiredSctProphylaxisCathegory
http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-sct-prophylaxis-cathegory-eu-pcsp
from this IG
Procedure.codeextensibleSctProphylaxisType
http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-sct-prophylaxis-type-eu-pcsp
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Identifiers for this SCT-related procedure
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest) A request for this procedure
... partOf Σ 0..* Reference(Procedure | Observation | MedicationAdministration) Part of referenced event
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.

... statusReason Σ 0..1 CodeableConcept Reason for current status
Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.

... category Σ 1..1 CodeableConcept Classification of the procedure
Binding: SCT Prophylaxis Cathegory (required)
... code Σ 0..1 CodeableConcept Identification of the procedure
Binding: SCT Prophylaxis Type (extensible)
... subject Σ 1..1 Reference(Patient: PCSP) Who the procedure was performed on
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... Slices for performed[x] Σ 0..1 When the procedure was performed
Slice: Unordered, Open by type:$this
.... performedDateTime dateTime
.... performedPeriod Period
.... performedString string
.... performedAge Age
.... performedRange Range
.... performed[x]:performedPeriod SΣ 0..1 Period When the procedure was performed
... recorder Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who recorded the procedure
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Person who asserts this procedure
... performer Σ 0..* BackboneElement The people who performed the procedure
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function Σ 0..1 CodeableConcept Type of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.

.... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) The reference to the practitioner
.... 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: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.


... reasonReference SΣ 2..* Reference(Condition: Primary Cancer | Procedure: Stem Cell Transplantation) The justification that the procedure was performed
... bodySite Σ 0..* CodeableConcept Target body sites
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... outcome Σ 0..1 CodeableConcept The result of procedure
Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.

... report 0..* Reference(DiagnosticReport | DocumentReference | Composition) Any report resulting from the procedure
... complication 0..* CodeableConcept Complication following the procedure
Binding: Condition/Problem/DiagnosisCodes (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: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures.


... note 0..* Annotation Additional information about the procedure
... focalDevice 0..* BackboneElement Manipulated, implanted, or removed device
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... action 0..1 CodeableConcept Kind of change to device
Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure.

.... manipulated 1..1 Reference(Device) Device that was changed
... usedReference 0..* Reference(Device | Medication | Substance) Items used during procedure
... usedCode 0..* CodeableConcept Coded items used during the procedure
Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
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.statusReasonexampleProcedureNotPerformedReason(SNOMED-CT)
http://hl7.org/fhir/ValueSet/procedure-not-performed-reason
from the FHIR Standard
Procedure.categoryrequiredSctProphylaxisCathegory
http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-sct-prophylaxis-cathegory-eu-pcsp
from this IG
Procedure.codeextensibleSctProphylaxisType
http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-sct-prophylaxis-type-eu-pcsp
from this IG
Procedure.performer.functionexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
Procedure.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
Procedure.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Procedure.outcomeexampleProcedureOutcomeCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-outcome
from the FHIR Standard
Procedure.complicationexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
Procedure.followUpexampleProcedureFollowUpCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-followup
from the FHIR Standard
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
http://hl7.org/fhir/ValueSet/device-action
from the FHIR Standard
Procedure.usedCodeexampleFHIRDeviceTypes
http://hl7.org/fhir/ValueSet/device-kind
from the FHIR Standard

This structure is derived from Procedure

Summary

Mandatory: 1 element
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Procedure.performed[x]

 

Other representations of profile: CSV, Excel, Schematron