SGHI FHIR Profile Implementation Guide
0.1.0 - ci-build

SGHI FHIR Profile Implementation Guide, published by Kathurima Kimathi. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/sil_fhir_profile_ig/ and changes regularly. See the Directory of published versions

Resource Profile: SGHI Procedure

Official URL: https://fhir.slade360.co.ke/fhir/StructureDefinition/sghi-procedure Version: 0.1.0
Draft as of 2025-09-04 Computable Name: SGHIProcedure

This resource is used to record the details of current and historical procedures performed on, with, or for a patient, practitioner, device, organization, or location. Examples include surgical procedures, diagnostic procedures, endoscopic procedures, biopsies, counseling, physiotherapy, personal support services, adult day care services, non-emergency transportation, home modification, exercise, verification of enrollment qualifications for a social program etc. Procedures may be performed by a healthcare professional, a service provider, a friend or relative or in some cases by the patient themselves.

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..* Procedure An action that is being or was performed on an individual or entity
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... basedOn Σ 1..1 SGHIReference(SGHI ServiceRequest) A request for this procedure
... partOf Σ 1..1 SGHIReference(SGHI Procedure | SGHI Observation) Part of referenced event
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: SGHI Procedure status value set (required)
... statusReason Σ 0..1 SGHICodeableConcept Reason for current status
Binding: All ICHI codes (required)
... category SΣ 1..1 SGHICodeableConcept Classification of the procedure
Binding: SGHI Procedure Category value set (extensible)
... code SΣ 1..1 SGHICodeableConcept Identification of the procedure
Binding: All ICHI codes (required)
.... coding Σ 1..* Coding Code defined by a terminology system
Binding: All ICHI codes (required)
..... system Σ 1..1 uri Identity of the terminology system
..... code ΣC 1..1 code Symbol in syntax defined by the system
..... display ΣC 1..1 string Representation defined by the system
... subject SΣ 1..1 SGHIReference(SGHI Patient | Practitioner) Individual or entity the procedure was performed on
... focus Σ 0..1 SGHIReference(SGHI Patient | Practitioner | PractitionerRole) Who is the target of the procedure when it is not the subject of record only
... encounter SΣ 1..1 SGHIReference(SGHI Encounter) The Encounter during which this Procedure was created
... Slices for occurrence[x] Σ 1..1 dateTime When the procedure occurred or is occurring
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime Σ 1..1 dateTime When the procedure occurred or is occurring
... recorded SΣ 1..1 dateTime When the procedure was first captured in the subject's record
... recorder SΣ 1..1 SGHIReference(SGHI Practitioner | SGHI PractitionerRole) Who recorded the procedure
... performer SΣC 1..1 BackboneElement Who performed the procedure and what they did
Constraints: prc-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor ΣC 1..1 SGHIReference(SGHI Practitioner | SGHI PractitionerRole) Who performed the procedure
.... onBehalfOf C 0..1 SGHIReference(SGHI Organization) Organization the device or practitioner was acting for
... location SΣ 1..1 SGHIReference(SGHI Location) Where the procedure happened
... bodySite SΣ 1..1 SGHICodeableConcept Target body sites
Binding: All ICHI codes (required)
... outcome SΣ 1..1 SGHICodeableConcept The result of procedure
Binding: SGHI Procedure outcome value set (required)
... report 1..* SGHIReference(SGHI DiagnosticReport | DocumentReference) Any report resulting from the procedure
... complication 0..* SGHICodeableReference(SGHI Condition) Complication following the procedure
Binding: ConditionProblemDiagnosisCodes (example): Codes describing complications that resulted from a procedure.
... followUp S 1..1 SGHICodeableConcept Instructions for follow up
Binding: SGHI Procedure follow up codes (required)
... note 0..* SGHIAnnotation Additional information about the procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Procedure.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Procedure.statusrequiredSGHIProcedureStatus
https://fhir.slade360.co.ke/fhir/ValueSet/procedure-status
From this IG
Procedure.statusReasonrequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.categoryextensibleSGHIProcedureCategory
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-category
From this IG
Procedure.coderequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.code.codingrequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.bodySiterequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.outcomerequiredSGHIProcedureOutcome
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-outcome
From this IG
Procedure.complicationexampleConditionProblemDiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
From the FHIR Standard
Procedure.followUprequiredSGHIProcedureFollowUpCodes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-follow-up-codes
From this IG

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
prc-1errorProcedure.performerProcedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole
: onBehalfOf.exists() and actor.resolve().exists() implies actor.resolve().where($this is Practitioner or $this is PractitionerRole).empty()

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... identifier 1..* Identifier External Identifiers for this procedure
.... use 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
.... assigner 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... basedOn 1..1 SGHIReference(SGHI ServiceRequest) A request for this procedure
... partOf 1..1 SGHIReference(SGHI Procedure | SGHI Observation) Part of referenced event
... statusReason 0..1 SGHICodeableConcept Reason for current status
Binding: All ICHI codes (required)
... category S 1..1 SGHICodeableConcept Classification of the procedure
Binding: SGHI Procedure Category value set (extensible)
... code S 1..1 SGHICodeableConcept Identification of the procedure
Binding: All ICHI codes (required)
.... coding 1..* Coding Code defined by a terminology system
Binding: All ICHI codes (required)
... subject S 1..1 SGHIReference(SGHI Patient | Practitioner) Individual or entity the procedure was performed on
... focus 0..1 SGHIReference(SGHI Patient | Practitioner | PractitionerRole) Who is the target of the procedure when it is not the subject of record only
... encounter S 1..1 SGHIReference(SGHI Encounter) The Encounter during which this Procedure was created
... Slices for occurrence[x] 1..1 dateTime When the procedure occurred or is occurring
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime 1..1 dateTime When the procedure occurred or is occurring
... recorded S 1..1 dateTime When the procedure was first captured in the subject's record
... recorder S 1..1 SGHIReference(SGHI Practitioner | SGHI PractitionerRole) Who recorded the procedure
... performer S 1..1 BackboneElement Who performed the procedure and what they did
.... actor 1..1 SGHIReference(SGHI Practitioner | SGHI PractitionerRole) Who performed the procedure
.... onBehalfOf 0..1 SGHIReference(SGHI Organization) Organization the device or practitioner was acting for
... location S 1..1 SGHIReference(SGHI Location) Where the procedure happened
... bodySite S 1..1 SGHICodeableConcept Target body sites
Binding: All ICHI codes (required)
... outcome S 1..1 SGHICodeableConcept The result of procedure
Binding: SGHI Procedure outcome value set (required)
... report 1..* SGHIReference(SGHI DiagnosticReport | DocumentReference) Any report resulting from the procedure
... complication 0..* SGHICodeableReference(SGHI Condition) Complication following the procedure
... followUp S 1..1 SGHICodeableConcept Instructions for follow up
Binding: SGHI Procedure follow up codes (required)
... note 0..* SGHIAnnotation Additional information about the procedure

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Procedure.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Procedure.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Procedure.statusrequiredSGHIProcedureStatus
https://fhir.slade360.co.ke/fhir/ValueSet/procedure-status
From this IG
Procedure.statusReasonrequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.categoryextensibleSGHIProcedureCategory
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-category
From this IG
Procedure.coderequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.code.codingrequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.bodySiterequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.outcomerequiredSGHIProcedureOutcome
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-outcome
From this IG
Procedure.followUprequiredSGHIProcedureFollowUpCodes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-follow-up-codes
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier External Identifiers for this procedure
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 1..1 SGHIReference(SGHI ServiceRequest) A request for this procedure
... partOf Σ 1..1 SGHIReference(SGHI Procedure | SGHI Observation) Part of referenced event
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: SGHI Procedure status value set (required)
... statusReason Σ 0..1 SGHICodeableConcept Reason for current status
Binding: All ICHI codes (required)
... category SΣ 1..1 SGHICodeableConcept Classification of the procedure
Binding: SGHI Procedure Category value set (extensible)
... code SΣ 1..1 SGHICodeableConcept Identification of the procedure
Binding: All ICHI codes (required)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..* Coding Code defined by a terminology system
Binding: All ICHI codes (required)
..... id 0..1 id 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
..... version Σ 0..1 string Version of the system - if relevant
..... code ΣC 1..1 code Symbol in syntax defined by the system
..... display ΣC 1..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 SΣ 1..1 SGHIReference(SGHI Patient | Practitioner) Individual or entity the procedure was performed on
... focus Σ 0..1 SGHIReference(SGHI Patient | Practitioner | PractitionerRole) Who is the target of the procedure when it is not the subject of record only
... encounter SΣ 1..1 SGHIReference(SGHI Encounter) The Encounter during which this Procedure was created
... Slices for occurrence[x] Σ 1..1 dateTime When the procedure occurred or is occurring
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime Σ 1..1 dateTime When the procedure occurred or is occurring
... recorded SΣ 1..1 dateTime When the procedure was first captured in the subject's record
... recorder SΣ 1..1 SGHIReference(SGHI Practitioner | SGHI PractitionerRole) Who recorded the procedure
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)
... performer SΣC 1..1 BackboneElement Who performed the procedure and what they did
Constraints: prc-1
.... 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 ΣC 1..1 SGHIReference(SGHI Practitioner | SGHI PractitionerRole) Who performed the procedure
.... onBehalfOf C 0..1 SGHIReference(SGHI Organization) Organization the device or practitioner was acting for
.... period 0..1 Period When the performer performed the procedure
... location SΣ 1..1 SGHIReference(SGHI Location) Where the procedure happened
... reason Σ 0..* CodeableReference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) The justification that the procedure was performed
Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
... bodySite SΣ 1..1 SGHICodeableConcept Target body sites
Binding: All ICHI codes (required)
... outcome SΣ 1..1 SGHICodeableConcept The result of procedure
Binding: SGHI Procedure outcome value set (required)
... report 1..* SGHIReference(SGHI DiagnosticReport | DocumentReference) Any report resulting from the procedure
... complication 0..* SGHICodeableReference(SGHI Condition) Complication following the procedure
Binding: ConditionProblemDiagnosisCodes (example): Codes describing complications that resulted from a procedure.
... followUp S 1..1 SGHICodeableConcept Instructions for follow up
Binding: SGHI Procedure follow up codes (required)
... note 0..* SGHIAnnotation 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
... used 0..* CodeableReference(Device | Medication | Substance | BiologicallyDerivedProduct) Items used during procedure
Binding: DeviceType (example): Codes describing items used during a procedure.
... supportingInfo 0..* Reference(Resource) Extra information relevant to the procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Procedure.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Procedure.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Procedure.statusrequiredSGHIProcedureStatus
https://fhir.slade360.co.ke/fhir/ValueSet/procedure-status
From this IG
Procedure.statusReasonrequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.categoryextensibleSGHIProcedureCategory
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-category
From this IG
Procedure.coderequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.code.codingrequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.performer.functionexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
From the FHIR Standard
Procedure.reasonexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
From the FHIR Standard
Procedure.bodySiterequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.outcomerequiredSGHIProcedureOutcome
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-outcome
From this IG
Procedure.complicationexampleConditionProblemDiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
From the FHIR Standard
Procedure.followUprequiredSGHIProcedureFollowUpCodes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-follow-up-codes
From this IG
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
http://hl7.org/fhir/ValueSet/device-action
From the FHIR Standard
Procedure.usedexampleDeviceType
http://hl7.org/fhir/ValueSet/device-type
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
prc-1errorProcedure.performerProcedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole
: onBehalfOf.exists() and actor.resolve().exists() implies actor.resolve().where($this is Practitioner or $this is PractitionerRole).empty()

This structure is derived from Procedure

Summary

Mandatory: 19 elements
Must-Support: 12 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.occurrence[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... basedOn Σ 1..1 SGHIReference(SGHI ServiceRequest) A request for this procedure
... partOf Σ 1..1 SGHIReference(SGHI Procedure | SGHI Observation) Part of referenced event
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: SGHI Procedure status value set (required)
... statusReason Σ 0..1 SGHICodeableConcept Reason for current status
Binding: All ICHI codes (required)
... category SΣ 1..1 SGHICodeableConcept Classification of the procedure
Binding: SGHI Procedure Category value set (extensible)
... code SΣ 1..1 SGHICodeableConcept Identification of the procedure
Binding: All ICHI codes (required)
.... coding Σ 1..* Coding Code defined by a terminology system
Binding: All ICHI codes (required)
..... system Σ 1..1 uri Identity of the terminology system
..... code ΣC 1..1 code Symbol in syntax defined by the system
..... display ΣC 1..1 string Representation defined by the system
... subject SΣ 1..1 SGHIReference(SGHI Patient | Practitioner) Individual or entity the procedure was performed on
... focus Σ 0..1 SGHIReference(SGHI Patient | Practitioner | PractitionerRole) Who is the target of the procedure when it is not the subject of record only
... encounter SΣ 1..1 SGHIReference(SGHI Encounter) The Encounter during which this Procedure was created
... Slices for occurrence[x] Σ 1..1 dateTime When the procedure occurred or is occurring
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime Σ 1..1 dateTime When the procedure occurred or is occurring
... recorded SΣ 1..1 dateTime When the procedure was first captured in the subject's record
... recorder SΣ 1..1 SGHIReference(SGHI Practitioner | SGHI PractitionerRole) Who recorded the procedure
... performer SΣC 1..1 BackboneElement Who performed the procedure and what they did
Constraints: prc-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor ΣC 1..1 SGHIReference(SGHI Practitioner | SGHI PractitionerRole) Who performed the procedure
.... onBehalfOf C 0..1 SGHIReference(SGHI Organization) Organization the device or practitioner was acting for
... location SΣ 1..1 SGHIReference(SGHI Location) Where the procedure happened
... bodySite SΣ 1..1 SGHICodeableConcept Target body sites
Binding: All ICHI codes (required)
... outcome SΣ 1..1 SGHICodeableConcept The result of procedure
Binding: SGHI Procedure outcome value set (required)
... report 1..* SGHIReference(SGHI DiagnosticReport | DocumentReference) Any report resulting from the procedure
... complication 0..* SGHICodeableReference(SGHI Condition) Complication following the procedure
Binding: ConditionProblemDiagnosisCodes (example): Codes describing complications that resulted from a procedure.
... followUp S 1..1 SGHICodeableConcept Instructions for follow up
Binding: SGHI Procedure follow up codes (required)
... note 0..* SGHIAnnotation Additional information about the procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Procedure.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Procedure.statusrequiredSGHIProcedureStatus
https://fhir.slade360.co.ke/fhir/ValueSet/procedure-status
From this IG
Procedure.statusReasonrequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.categoryextensibleSGHIProcedureCategory
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-category
From this IG
Procedure.coderequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.code.codingrequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.bodySiterequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.outcomerequiredSGHIProcedureOutcome
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-outcome
From this IG
Procedure.complicationexampleConditionProblemDiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
From the FHIR Standard
Procedure.followUprequiredSGHIProcedureFollowUpCodes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-follow-up-codes
From this IG

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
prc-1errorProcedure.performerProcedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole
: onBehalfOf.exists() and actor.resolve().exists() implies actor.resolve().where($this is Practitioner or $this is PractitionerRole).empty()

Differential View

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... identifier 1..* Identifier External Identifiers for this procedure
.... use 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
.... assigner 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... basedOn 1..1 SGHIReference(SGHI ServiceRequest) A request for this procedure
... partOf 1..1 SGHIReference(SGHI Procedure | SGHI Observation) Part of referenced event
... statusReason 0..1 SGHICodeableConcept Reason for current status
Binding: All ICHI codes (required)
... category S 1..1 SGHICodeableConcept Classification of the procedure
Binding: SGHI Procedure Category value set (extensible)
... code S 1..1 SGHICodeableConcept Identification of the procedure
Binding: All ICHI codes (required)
.... coding 1..* Coding Code defined by a terminology system
Binding: All ICHI codes (required)
... subject S 1..1 SGHIReference(SGHI Patient | Practitioner) Individual or entity the procedure was performed on
... focus 0..1 SGHIReference(SGHI Patient | Practitioner | PractitionerRole) Who is the target of the procedure when it is not the subject of record only
... encounter S 1..1 SGHIReference(SGHI Encounter) The Encounter during which this Procedure was created
... Slices for occurrence[x] 1..1 dateTime When the procedure occurred or is occurring
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime 1..1 dateTime When the procedure occurred or is occurring
... recorded S 1..1 dateTime When the procedure was first captured in the subject's record
... recorder S 1..1 SGHIReference(SGHI Practitioner | SGHI PractitionerRole) Who recorded the procedure
... performer S 1..1 BackboneElement Who performed the procedure and what they did
.... actor 1..1 SGHIReference(SGHI Practitioner | SGHI PractitionerRole) Who performed the procedure
.... onBehalfOf 0..1 SGHIReference(SGHI Organization) Organization the device or practitioner was acting for
... location S 1..1 SGHIReference(SGHI Location) Where the procedure happened
... bodySite S 1..1 SGHICodeableConcept Target body sites
Binding: All ICHI codes (required)
... outcome S 1..1 SGHICodeableConcept The result of procedure
Binding: SGHI Procedure outcome value set (required)
... report 1..* SGHIReference(SGHI DiagnosticReport | DocumentReference) Any report resulting from the procedure
... complication 0..* SGHICodeableReference(SGHI Condition) Complication following the procedure
... followUp S 1..1 SGHICodeableConcept Instructions for follow up
Binding: SGHI Procedure follow up codes (required)
... note 0..* SGHIAnnotation Additional information about the procedure

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Procedure.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Procedure.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Procedure.statusrequiredSGHIProcedureStatus
https://fhir.slade360.co.ke/fhir/ValueSet/procedure-status
From this IG
Procedure.statusReasonrequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.categoryextensibleSGHIProcedureCategory
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-category
From this IG
Procedure.coderequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.code.codingrequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.bodySiterequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.outcomerequiredSGHIProcedureOutcome
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-outcome
From this IG
Procedure.followUprequiredSGHIProcedureFollowUpCodes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-follow-up-codes
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on an individual or entity
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier External Identifiers for this procedure
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 SGHICodeableConcept Description of identifier
Binding: SGHI Standard Identifier Types (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 1..1 SGHIReference(SGHI Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 1..1 SGHIReference(SGHI ServiceRequest) A request for this procedure
... partOf Σ 1..1 SGHIReference(SGHI Procedure | SGHI Observation) Part of referenced event
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: SGHI Procedure status value set (required)
... statusReason Σ 0..1 SGHICodeableConcept Reason for current status
Binding: All ICHI codes (required)
... category SΣ 1..1 SGHICodeableConcept Classification of the procedure
Binding: SGHI Procedure Category value set (extensible)
... code SΣ 1..1 SGHICodeableConcept Identification of the procedure
Binding: All ICHI codes (required)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..* Coding Code defined by a terminology system
Binding: All ICHI codes (required)
..... id 0..1 id 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
..... version Σ 0..1 string Version of the system - if relevant
..... code ΣC 1..1 code Symbol in syntax defined by the system
..... display ΣC 1..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 SΣ 1..1 SGHIReference(SGHI Patient | Practitioner) Individual or entity the procedure was performed on
... focus Σ 0..1 SGHIReference(SGHI Patient | Practitioner | PractitionerRole) Who is the target of the procedure when it is not the subject of record only
... encounter SΣ 1..1 SGHIReference(SGHI Encounter) The Encounter during which this Procedure was created
... Slices for occurrence[x] Σ 1..1 dateTime When the procedure occurred or is occurring
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime Σ 1..1 dateTime When the procedure occurred or is occurring
... recorded SΣ 1..1 dateTime When the procedure was first captured in the subject's record
... recorder SΣ 1..1 SGHIReference(SGHI Practitioner | SGHI PractitionerRole) Who recorded the procedure
... reported[x] Σ 0..1 Reported rather than primary record
.... reportedBoolean boolean
.... reportedReference Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)
... performer SΣC 1..1 BackboneElement Who performed the procedure and what they did
Constraints: prc-1
.... 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 ΣC 1..1 SGHIReference(SGHI Practitioner | SGHI PractitionerRole) Who performed the procedure
.... onBehalfOf C 0..1 SGHIReference(SGHI Organization) Organization the device or practitioner was acting for
.... period 0..1 Period When the performer performed the procedure
... location SΣ 1..1 SGHIReference(SGHI Location) Where the procedure happened
... reason Σ 0..* CodeableReference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) The justification that the procedure was performed
Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
... bodySite SΣ 1..1 SGHICodeableConcept Target body sites
Binding: All ICHI codes (required)
... outcome SΣ 1..1 SGHICodeableConcept The result of procedure
Binding: SGHI Procedure outcome value set (required)
... report 1..* SGHIReference(SGHI DiagnosticReport | DocumentReference) Any report resulting from the procedure
... complication 0..* SGHICodeableReference(SGHI Condition) Complication following the procedure
Binding: ConditionProblemDiagnosisCodes (example): Codes describing complications that resulted from a procedure.
... followUp S 1..1 SGHICodeableConcept Instructions for follow up
Binding: SGHI Procedure follow up codes (required)
... note 0..* SGHIAnnotation 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
... used 0..* CodeableReference(Device | Medication | Substance | BiologicallyDerivedProduct) Items used during procedure
Binding: DeviceType (example): Codes describing items used during a procedure.
... supportingInfo 0..* Reference(Resource) Extra information relevant to the procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Procedure.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
From the FHIR Standard
Procedure.identifier.typerequiredSGHIIdentifierTypes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types
From this IG
Procedure.statusrequiredSGHIProcedureStatus
https://fhir.slade360.co.ke/fhir/ValueSet/procedure-status
From this IG
Procedure.statusReasonrequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.categoryextensibleSGHIProcedureCategory
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-category
From this IG
Procedure.coderequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.code.codingrequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.performer.functionexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
From the FHIR Standard
Procedure.reasonexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
From the FHIR Standard
Procedure.bodySiterequiredICHICodes(a valid code from http://id.who.int/icd/release/11/beta/ichi)
https://fhir.slade360.co.ke/fhir/ValueSet/ICHICodes
From this IG
Procedure.outcomerequiredSGHIProcedureOutcome
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-outcome
From this IG
Procedure.complicationexampleConditionProblemDiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
From the FHIR Standard
Procedure.followUprequiredSGHIProcedureFollowUpCodes
https://fhir.slade360.co.ke/fhir/ValueSet/sghi-procedure-follow-up-codes
From this IG
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
http://hl7.org/fhir/ValueSet/device-action
From the FHIR Standard
Procedure.usedexampleDeviceType
http://hl7.org/fhir/ValueSet/device-type
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
prc-1errorProcedure.performerProcedure.performer.onBehalfOf can only be populated when performer.actor isn't Practitioner or PractitionerRole
: onBehalfOf.exists() and actor.resolve().exists() implies actor.resolve().where($this is Practitioner or $this is PractitionerRole).empty()

This structure is derived from Procedure

Summary

Mandatory: 19 elements
Must-Support: 12 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.occurrence[x]

 

Other representations of profile: CSV, Excel, Schematron