oncologyfhirigkenya - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: Oncology Procedure Kenya
| Official URL: http://example.org/StructureDefinition/oncology-kenya-procedure | Version: 0.1.0 | |||
| Draft as of 2025-06-24 | Computable Name: OncologyKenyaProcedure | |||
Procedure profile tailored for oncology use in Kenya, supporting documentation of diagnostic, surgical, medical, radiotherapy, and palliative interventions. Aligned with Kenya National Cancer Control Strategy (2023–2027), Cancer Policy (2020–2030), KEMRI registry practices, and county-level reporting, using ICD-10 as the sole terminology for reporting procedures and conditions.
Usages:
- Examples for this Profile: Procedure/example-surgical-biopsy
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Procedure
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| Procedure.category | extensible | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.code | required | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.reasonCode | extensible | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.outcome | preferred | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.complication | extensible | http://id.who.int/icd10http://id.who.int/icd10 |
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Procedure |
0..* | Procedure | 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:county |
0..1 | CodeableConcept | County Where Procedure Was Performed URL: http://example.org/StructureDefinition/procedure-context-county Binding: https://www.kenyacode.com/fhir/ValueSet/kenya-county-codes (required) | |
| extension:cancerStage |
0..1 | CodeableConcept | Cancer Stage at Time of Procedure URL: http://example.org/StructureDefinition/procedure-cancer-stage Binding: http://id.who.int/icd10 (extensible) | |
| extension:referralSource |
0..1 | CodeableConcept | Referral Source for Procedure URL: http://example.org/StructureDefinition/procedure-referral-source Binding: https://www.sha.go.ke/fhir/ValueSet/kenya-referral-sources (extensible) | |
 extension:reportToRegistry |
0..1 | boolean | Flag for National Registry Reporting URL: http://example.org/StructureDefinition/procedure-registry-report-flag | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| 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. |
 category |
SΣ | 0..1 | CodeableConcept | Classification of the procedure Binding: http://id.who.int/icd10 (extensible) |
| code |
SΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: http://id.who.int/icd10 (required) |
 subject |
SΣ | 1..1 | Reference(Patient | Group) | Who the procedure was performed on |
 performed[x] |
SΣ | 1..1 | When the procedure was performed | |
| performedDateTime |
dateTime | |||
 performedPeriod |
Period | |||
| performer |
SΣ | 0..* | BackboneElement | The people who performed the procedure |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner |
| location |
SΣ | 0..1 | Reference(Location) | Where the procedure happened |
| reasonCode |
SΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: http://id.who.int/icd10 (extensible) |
| bodySite |
SΣ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| outcome |
SΣ | 0..1 | CodeableConcept | The result of procedure Binding: http://id.who.int/icd10 (preferred) |
| complication |
S | 0..* | CodeableConcept | Complication following the procedure Binding: http://id.who.int/icd10 (extensible) |
| note |
S | 0..* | Annotation | Additional information about the procedure |
| usedReference |
S | 0..* | Reference(Device | Medication | Substance) | Items used during procedure |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1From the FHIR Standard | |
| Procedure.category | extensible | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.code | required | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.reasonCode | extensible | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | |
| Procedure.outcome | preferred | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.complication | extensible | http://id.who.int/icd10http://id.who.int/icd10 |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Procedure | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Procedure | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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:county |
0..1 | CodeableConcept | County Where Procedure Was Performed URL: http://example.org/StructureDefinition/procedure-context-county Binding: https://www.kenyacode.com/fhir/ValueSet/kenya-county-codes (required) | |||||
| extension:cancerStage |
0..1 | CodeableConcept | Cancer Stage at Time of Procedure URL: http://example.org/StructureDefinition/procedure-cancer-stage Binding: http://id.who.int/icd10 (extensible) | |||||
| extension:referralSource |
0..1 | CodeableConcept | Referral Source for Procedure URL: http://example.org/StructureDefinition/procedure-referral-source Binding: https://www.sha.go.ke/fhir/ValueSet/kenya-referral-sources (extensible) | |||||
| extension:reportToRegistry |
0..1 | boolean | Flag for National Registry Reporting URL: http://example.org/StructureDefinition/procedure-registry-report-flag | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Identifiers for this 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 |
SΣ | 0..1 | CodeableConcept | Classification of the procedure Binding: http://id.who.int/icd10 (extensible) | ||||
| code |
SΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: http://id.who.int/icd10 (required) | ||||
| subject |
SΣ | 1..1 | Reference(Patient | Group) | Who the procedure was performed on | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| performed[x] |
SΣ | 1..1 | When the procedure was performed | |||||
| performedDateTime |
dateTime | |||||||
| performedPeriod |
Period | |||||||
| 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 |
SΣ | 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 |
SΣ | 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 |
SΣ | 0..1 | Reference(Location) | Where the procedure happened | ||||
| reasonCode |
SΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: http://id.who.int/icd10 (extensible) | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed | ||||
| bodySite |
SΣ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| outcome |
SΣ | 0..1 | CodeableConcept | The result of procedure Binding: http://id.who.int/icd10 (preferred) | ||||
| report |
0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
| complication |
S | 0..* | CodeableConcept | Complication following the procedure Binding: http://id.who.int/icd10 (extensible) | ||||
| 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 |
S | 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 |
S | 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. | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| Procedure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1From the FHIR Standard | ||||
| Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT)http://hl7.org/fhir/ValueSet/procedure-not-performed-reasonFrom the FHIR Standard | ||||
| Procedure.category | extensible | http://id.who.int/icd10http://id.who.int/icd10 | ||||
| Procedure.code | required | http://id.who.int/icd10http://id.who.int/icd10 | ||||
| Procedure.performer.function | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-roleFrom the FHIR Standard | ||||
| Procedure.reasonCode | extensible | http://id.who.int/icd10http://id.who.int/icd10 | ||||
| Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | ||||
| Procedure.outcome | preferred | http://id.who.int/icd10http://id.who.int/icd10 | ||||
| Procedure.complication | extensible | http://id.who.int/icd10http://id.who.int/icd10 | ||||
| Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-followupFrom the FHIR Standard | ||||
| Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodeshttp://hl7.org/fhir/ValueSet/device-actionFrom the FHIR Standard | ||||
| Procedure.usedCode | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kindFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Procedure | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Procedure | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Procedure
Differential View
This structure is derived from Procedure
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| Procedure.category | extensible | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.code | required | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.reasonCode | extensible | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.outcome | preferred | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.complication | extensible | http://id.who.int/icd10http://id.who.int/icd10 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Procedure |
0..* | Procedure | 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:county |
0..1 | CodeableConcept | County Where Procedure Was Performed URL: http://example.org/StructureDefinition/procedure-context-county Binding: https://www.kenyacode.com/fhir/ValueSet/kenya-county-codes (required) | |
| extension:cancerStage |
0..1 | CodeableConcept | Cancer Stage at Time of Procedure URL: http://example.org/StructureDefinition/procedure-cancer-stage Binding: http://id.who.int/icd10 (extensible) | |
| extension:referralSource |
0..1 | CodeableConcept | Referral Source for Procedure URL: http://example.org/StructureDefinition/procedure-referral-source Binding: https://www.sha.go.ke/fhir/ValueSet/kenya-referral-sources (extensible) | |
| extension:reportToRegistry |
0..1 | boolean | Flag for National Registry Reporting URL: http://example.org/StructureDefinition/procedure-registry-report-flag | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| 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. |
| category |
SΣ | 0..1 | CodeableConcept | Classification of the procedure Binding: http://id.who.int/icd10 (extensible) |
| code |
SΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: http://id.who.int/icd10 (required) |
| subject |
SΣ | 1..1 | Reference(Patient | Group) | Who the procedure was performed on |
| performed[x] |
SΣ | 1..1 | When the procedure was performed | |
| performedDateTime |
dateTime | |||
| performedPeriod |
Period | |||
| performer |
SΣ | 0..* | BackboneElement | The people who performed the procedure |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner |
| location |
SΣ | 0..1 | Reference(Location) | Where the procedure happened |
| reasonCode |
SΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: http://id.who.int/icd10 (extensible) |
| bodySite |
SΣ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| outcome |
SΣ | 0..1 | CodeableConcept | The result of procedure Binding: http://id.who.int/icd10 (preferred) |
| complication |
S | 0..* | CodeableConcept | Complication following the procedure Binding: http://id.who.int/icd10 (extensible) |
| note |
S | 0..* | Annotation | Additional information about the procedure |
| usedReference |
S | 0..* | Reference(Device | Medication | Substance) | Items used during procedure |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1From the FHIR Standard | |
| Procedure.category | extensible | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.code | required | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.reasonCode | extensible | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | |
| Procedure.outcome | preferred | http://id.who.int/icd10http://id.who.int/icd10 | |
| Procedure.complication | extensible | http://id.who.int/icd10http://id.who.int/icd10 |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Procedure | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Procedure | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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:county |
0..1 | CodeableConcept | County Where Procedure Was Performed URL: http://example.org/StructureDefinition/procedure-context-county Binding: https://www.kenyacode.com/fhir/ValueSet/kenya-county-codes (required) | |||||
| extension:cancerStage |
0..1 | CodeableConcept | Cancer Stage at Time of Procedure URL: http://example.org/StructureDefinition/procedure-cancer-stage Binding: http://id.who.int/icd10 (extensible) | |||||
| extension:referralSource |
0..1 | CodeableConcept | Referral Source for Procedure URL: http://example.org/StructureDefinition/procedure-referral-source Binding: https://www.sha.go.ke/fhir/ValueSet/kenya-referral-sources (extensible) | |||||
| extension:reportToRegistry |
0..1 | boolean | Flag for National Registry Reporting URL: http://example.org/StructureDefinition/procedure-registry-report-flag | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Identifiers for this 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 |
SΣ | 0..1 | CodeableConcept | Classification of the procedure Binding: http://id.who.int/icd10 (extensible) | ||||
| code |
SΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: http://id.who.int/icd10 (required) | ||||
| subject |
SΣ | 1..1 | Reference(Patient | Group) | Who the procedure was performed on | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| performed[x] |
SΣ | 1..1 | When the procedure was performed | |||||
| performedDateTime |
dateTime | |||||||
| performedPeriod |
Period | |||||||
| 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 |
SΣ | 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 |
SΣ | 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 |
SΣ | 0..1 | Reference(Location) | Where the procedure happened | ||||
| reasonCode |
SΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: http://id.who.int/icd10 (extensible) | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed | ||||
| bodySite |
SΣ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| outcome |
SΣ | 0..1 | CodeableConcept | The result of procedure Binding: http://id.who.int/icd10 (preferred) | ||||
| report |
0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
| complication |
S | 0..* | CodeableConcept | Complication following the procedure Binding: http://id.who.int/icd10 (extensible) | ||||
| 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 |
S | 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 |
S | 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. | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| Procedure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1From the FHIR Standard | ||||
| Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT)http://hl7.org/fhir/ValueSet/procedure-not-performed-reasonFrom the FHIR Standard | ||||
| Procedure.category | extensible | http://id.who.int/icd10http://id.who.int/icd10 | ||||
| Procedure.code | required | http://id.who.int/icd10http://id.who.int/icd10 | ||||
| Procedure.performer.function | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-roleFrom the FHIR Standard | ||||
| Procedure.reasonCode | extensible | http://id.who.int/icd10http://id.who.int/icd10 | ||||
| Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | ||||
| Procedure.outcome | preferred | http://id.who.int/icd10http://id.who.int/icd10 | ||||
| Procedure.complication | extensible | http://id.who.int/icd10http://id.who.int/icd10 | ||||
| Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-followupFrom the FHIR Standard | ||||
| Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodeshttp://hl7.org/fhir/ValueSet/device-actionFrom the FHIR Standard | ||||
| Procedure.usedCode | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kindFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Procedure | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Procedure | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Procedure
Other representations of profile: CSV, Excel, Schematron