Draft PH Core Implementation Guide
0.2.0 - ci-build
Draft PH Core Implementation Guide
0.2.0 - ci-build
Draft PH Core Implementation Guide, published by UP Manila National TeleHealth Center. 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/eabuenaventura/eab-ph-core/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir.doh.gov.ph/phcore/StructureDefinition/ph-core-procedure | Version: 0.2.0 | ||||
| Draft as of 2026-06-17 | Computable Name: PHCoreProcedure | ||||
An action that is or was performed on or for a patient, practitioner, device, organization, or location.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| 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 | ||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
 partOf |
Σ | 0..* | Reference(PH Core Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||||||
| status |
?!SOΣ | 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 |
SOΣ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.
| ||||||||
 coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
 text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| category |
SOΣ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| code |
SOΣ | 0..1 | CodeableConcept | Identification of the procedure Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| subject |
SOΣ | 1..1 | Reference(PH Core Patient | Group) | Who the procedure was performed on
| ||||||||
| encounter |
SOΣ | 0..1 | Reference(PH Core Encounter) | Encounter created as part of
| ||||||||
 performed[x] |
SOΣ | 0..1 | When the procedure was performed
| |||||||||
| performedDateTime |
dateTime | |||||||||||
| performedPeriod |
Period | |||||||||||
| performedString |
string | |||||||||||
| performedAge |
Age | |||||||||||
| performedRange |
Range | |||||||||||
| recorder |
Σ | 0..1 | Reference(PH Core Patient | PH Core RelatedPerson | PH Core Practitioner | PH Core PractitionerRole) | Who recorded the procedure | ||||||||
| asserter |
Σ | 0..1 | Reference(PH Core Patient | PH Core RelatedPerson | PH Core Practitioner | PH Core PractitionerRole) | Person who asserts this procedure | ||||||||
| performer |
Σ | 0..* | BackboneElement | The people who performed the procedure | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| function |
SOΣ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| actor |
Σ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | Device) | The reference to the practitioner | ||||||||
| onBehalfOf |
0..1 | Reference(PH Core Organization) | Organization the device or practitioner was acting for | |||||||||
| location |
Σ | 0..1 | Reference(PH Core Location) | Where the procedure happened | ||||||||
| reasonCode |
SOΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| reasonReference |
SOΣ | 0..* | Reference(Condition | PH Core Observation | PH Core Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed
| ||||||||
| bodySite |
SOΣ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| outcome |
SOΣ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| complication |
SO | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| followUp |
SO | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| focalDevice |
0..* | BackboneElement | Manipulated, implanted, or removed device | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| action |
SO | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| manipulated |
1..1 | Reference(Device) | Device that was changed | |||||||||
| usedReference |
0..* | Reference(Device | PH Core Medication | Substance) | Items used during procedure | |||||||||
 usedCode |
SO | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure.
| ||||||||
 coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| Documentation for this format | ||||||||||||
| Id | Grade | Path(s) | Description | Expression |
| 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 | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Procedure |
|||
 status |
|
|
|
| statusReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| category |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| subject |
|
|
|
| encounter |
|
|
|
| performed[x] |
|
|
|
| performer |
|||
| function |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonReference |
|
|
|
| bodySite |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| outcome |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| complication |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| followUp |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| focalDevice |
|||
| action |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| usedCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
| 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 | |||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| 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(PH Core Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||||||
| status |
?!SOΣ | 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 |
SOΣ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| category |
SOΣ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| code |
SOΣ | 0..1 | CodeableConcept | Identification of the procedure Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| subject |
SOΣ | 1..1 | Reference(PH Core Patient | Group) | Who the procedure was performed on
| ||||||||
| encounter |
SOΣ | 0..1 | Reference(PH Core Encounter) | Encounter created as part of
| ||||||||
| performed[x] |
SOΣ | 0..1 | When the procedure was performed
| |||||||||
| performedDateTime |
dateTime | |||||||||||
| performedPeriod |
Period | |||||||||||
| performedString |
string | |||||||||||
| performedAge |
Age | |||||||||||
| performedRange |
Range | |||||||||||
| recorder |
Σ | 0..1 | Reference(PH Core Patient | PH Core RelatedPerson | PH Core Practitioner | PH Core PractitionerRole) | Who recorded the procedure | ||||||||
| asserter |
Σ | 0..1 | Reference(PH Core Patient | PH Core RelatedPerson | PH Core Practitioner | PH Core 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 |
SOΣ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| actor |
Σ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | Device) | The reference to the practitioner | ||||||||
| onBehalfOf |
0..1 | Reference(PH Core Organization) | Organization the device or practitioner was acting for | |||||||||
| location |
Σ | 0..1 | Reference(PH Core Location) | Where the procedure happened | ||||||||
| reasonCode |
SOΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| reasonReference |
SOΣ | 0..* | Reference(Condition | PH Core Observation | PH Core Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed
| ||||||||
| bodySite |
SOΣ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| outcome |
SOΣ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| report |
0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||||||
| complication |
SO | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| complicationDetail |
0..* | Reference(Condition) | A condition that is a result of the procedure | |||||||||
| followUp |
SO | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| 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 |
SO | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| manipulated |
1..1 | Reference(Device) | Device that was changed | |||||||||
| usedReference |
0..* | Reference(Device | PH Core Medication | Substance) | Items used during procedure | |||||||||
| usedCode |
SO | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| Documentation for this format | ||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Procedure |
|||
| status |
|
|
|
| statusReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| category |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| subject |
|
|
|
| encounter |
|
|
|
| performed[x] |
|
|
|
| performer |
|||
| function |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonReference |
|
|
|
| bodySite |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| outcome |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| complication |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| followUp |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| focalDevice |
|||
| action |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| usedCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Procedure.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Procedure.statusReason | Base | example | Procedure Not Performed Reason (SNOMED-CT) | 📍4.0.1 | FHIR Std. |
| Procedure.category | Base | example | Procedure Category Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.code | Base | example | Procedure Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.performer.function | Base | example | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std. |
| Procedure.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Procedure.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Procedure.outcome | Base | example | Procedure Outcome Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.complication | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| Procedure.followUp | Base | example | Procedure Follow up Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.focalDevice.action | Base | preferred | Procedure Device Action Codes | 📍4.0.1 | FHIR Std. |
| Procedure.usedCode | Base | example | FHIR Device Types | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Procedure |
|||
| status |
|
|
|
| statusReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| category |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| subject |
|
|
|
| encounter |
|
|
|
| performed[x] |
|
|
|
| performer |
|||
| function |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonReference |
|
|
|
| bodySite |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| outcome |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| complication |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| followUp |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| focalDevice |
|||
| action |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| usedCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Summary
Must-Support: 38 elements
Structures
This structure refers to these other structures:
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 | ||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| partOf |
Σ | 0..* | Reference(PH Core Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||||||
| status |
?!SOΣ | 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 |
SOΣ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| category |
SOΣ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| code |
SOΣ | 0..1 | CodeableConcept | Identification of the procedure Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| subject |
SOΣ | 1..1 | Reference(PH Core Patient | Group) | Who the procedure was performed on
| ||||||||
| encounter |
SOΣ | 0..1 | Reference(PH Core Encounter) | Encounter created as part of
| ||||||||
| performed[x] |
SOΣ | 0..1 | When the procedure was performed
| |||||||||
| performedDateTime |
dateTime | |||||||||||
| performedPeriod |
Period | |||||||||||
| performedString |
string | |||||||||||
| performedAge |
Age | |||||||||||
| performedRange |
Range | |||||||||||
| recorder |
Σ | 0..1 | Reference(PH Core Patient | PH Core RelatedPerson | PH Core Practitioner | PH Core PractitionerRole) | Who recorded the procedure | ||||||||
| asserter |
Σ | 0..1 | Reference(PH Core Patient | PH Core RelatedPerson | PH Core Practitioner | PH Core PractitionerRole) | Person who asserts this procedure | ||||||||
| performer |
Σ | 0..* | BackboneElement | The people who performed the procedure | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| function |
SOΣ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| actor |
Σ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | Device) | The reference to the practitioner | ||||||||
| onBehalfOf |
0..1 | Reference(PH Core Organization) | Organization the device or practitioner was acting for | |||||||||
| location |
Σ | 0..1 | Reference(PH Core Location) | Where the procedure happened | ||||||||
| reasonCode |
SOΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| reasonReference |
SOΣ | 0..* | Reference(Condition | PH Core Observation | PH Core Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed
| ||||||||
| bodySite |
SOΣ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| outcome |
SOΣ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| complication |
SO | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| followUp |
SO | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| focalDevice |
0..* | BackboneElement | Manipulated, implanted, or removed device | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| action |
SO | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| manipulated |
1..1 | Reference(Device) | Device that was changed | |||||||||
| usedReference |
0..* | Reference(Device | PH Core Medication | Substance) | Items used during procedure | |||||||||
| usedCode |
SO | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure.
| ||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| Documentation for this format | ||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Procedure |
|||
| status |
|
|
|
| statusReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| category |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| subject |
|
|
|
| encounter |
|
|
|
| performed[x] |
|
|
|
| performer |
|||
| function |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonReference |
|
|
|
| bodySite |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| outcome |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| complication |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| followUp |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| focalDevice |
|||
| action |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| usedCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Procedure.statusReason | Base | example | Procedure Not Performed Reason (SNOMED-CT) | 📍4.0.1 | FHIR Std. |
| Procedure.category | Base | example | Procedure Category Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.code | Base | example | Procedure Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.performer.function | Base | example | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std. |
| Procedure.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Procedure.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Procedure.outcome | Base | example | Procedure Outcome Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.complication | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| Procedure.followUp | Base | example | Procedure Follow up Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.focalDevice.action | Base | preferred | Procedure Device Action Codes | 📍4.0.1 | FHIR Std. |
| Procedure.usedCode | Base | example | FHIR Device Types | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Procedure |
0..* | Procedure | An action that is being or was performed on a patient | |||||||||
| partOf |
0..* | Reference(PH Core Procedure | Observation | MedicationAdministration) | Part of referenced event | |||||||||
| status |
SO | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
| ||||||||
| statusReason |
SO | 0..1 | CodeableConcept | Reason for current status
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| category |
SO | 0..1 | CodeableConcept | Classification of the procedure
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| code |
SO | 0..1 | CodeableConcept | Identification of the procedure
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| subject |
SO | 1..1 | Reference(PH Core Patient | Group) | Who the procedure was performed on
| ||||||||
| encounter |
SO | 0..1 | Reference(PH Core Encounter) | Encounter created as part of
| ||||||||
| performed[x] |
SO | 0..1 | dateTime, Period, string, Age, Range | When the procedure was performed
| ||||||||
| recorder |
0..1 | Reference(PH Core Patient | PH Core RelatedPerson | PH Core Practitioner | PH Core PractitionerRole) | Who recorded the procedure | |||||||||
| asserter |
0..1 | Reference(PH Core Patient | PH Core RelatedPerson | PH Core Practitioner | PH Core PractitionerRole) | Person who asserts this procedure | |||||||||
| performer |
||||||||||||
| function |
SO | 0..1 | CodeableConcept | Type of performance
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| actor |
1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | Device) | The reference to the practitioner | |||||||||
| onBehalfOf |
0..1 | Reference(PH Core Organization) | Organization the device or practitioner was acting for | |||||||||
| location |
0..1 | Reference(PH Core Location) | Where the procedure happened | |||||||||
| reasonCode |
SO | 0..* | CodeableConcept | Coded reason procedure performed
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| reasonReference |
SO | 0..* | Reference(Condition | PH Core Observation | PH Core Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed
| ||||||||
| bodySite |
SO | 0..* | CodeableConcept | Target body sites
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| outcome |
SO | 0..1 | CodeableConcept | The result of procedure
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| complication |
SO | 0..* | CodeableConcept | Complication following the procedure
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| followUp |
SO | 0..* | CodeableConcept | Instructions for follow up
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| focalDevice |
||||||||||||
| action |
SO | 0..1 | CodeableConcept | Kind of change to device
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| usedReference |
0..* | Reference(Device | PH Core Medication | Substance) | Items used during procedure | |||||||||
| usedCode |
SO | 0..* | CodeableConcept | Coded items used during the procedure
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| Documentation for this format | ||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Procedure |
|||
| status |
|
|
|
| statusReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| category |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| subject |
|
|
|
| encounter |
|
|
|
| performed[x] |
|
|
|
| performer |
|||
| function |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonReference |
|
|
|
| bodySite |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| outcome |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| complication |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| followUp |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| focalDevice |
|||
| action |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| usedCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Snapshot ViewView
| 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 | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| 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(PH Core Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||||||
| status |
?!SOΣ | 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 |
SOΣ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| category |
SOΣ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| code |
SOΣ | 0..1 | CodeableConcept | Identification of the procedure Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| subject |
SOΣ | 1..1 | Reference(PH Core Patient | Group) | Who the procedure was performed on
| ||||||||
| encounter |
SOΣ | 0..1 | Reference(PH Core Encounter) | Encounter created as part of
| ||||||||
| performed[x] |
SOΣ | 0..1 | When the procedure was performed
| |||||||||
| performedDateTime |
dateTime | |||||||||||
| performedPeriod |
Period | |||||||||||
| performedString |
string | |||||||||||
| performedAge |
Age | |||||||||||
| performedRange |
Range | |||||||||||
| recorder |
Σ | 0..1 | Reference(PH Core Patient | PH Core RelatedPerson | PH Core Practitioner | PH Core PractitionerRole) | Who recorded the procedure | ||||||||
| asserter |
Σ | 0..1 | Reference(PH Core Patient | PH Core RelatedPerson | PH Core Practitioner | PH Core 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 |
SOΣ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| actor |
Σ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization | PH Core Patient | PH Core RelatedPerson | Device) | The reference to the practitioner | ||||||||
| onBehalfOf |
0..1 | Reference(PH Core Organization) | Organization the device or practitioner was acting for | |||||||||
| location |
Σ | 0..1 | Reference(PH Core Location) | Where the procedure happened | ||||||||
| reasonCode |
SOΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| reasonReference |
SOΣ | 0..* | Reference(Condition | PH Core Observation | PH Core Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed
| ||||||||
| bodySite |
SOΣ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| outcome |
SOΣ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| report |
0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||||||
| complication |
SO | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| complicationDetail |
0..* | Reference(Condition) | A condition that is a result of the procedure | |||||||||
| followUp |
SO | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| 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 |
SO | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| manipulated |
1..1 | Reference(Device) | Device that was changed | |||||||||
| usedReference |
0..* | Reference(Device | PH Core Medication | Substance) | Items used during procedure | |||||||||
| usedCode |
SO | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure.
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| Documentation for this format | ||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Procedure |
|||
| status |
|
|
|
| statusReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| category |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| subject |
|
|
|
| encounter |
|
|
|
| performed[x] |
|
|
|
| performer |
|||
| function |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonReference |
|
|
|
| bodySite |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| outcome |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| complication |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| followUp |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| focalDevice |
|||
| action |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| usedCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Procedure.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Procedure.statusReason | Base | example | Procedure Not Performed Reason (SNOMED-CT) | 📍4.0.1 | FHIR Std. |
| Procedure.category | Base | example | Procedure Category Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.code | Base | example | Procedure Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.performer.function | Base | example | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std. |
| Procedure.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Procedure.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Procedure.outcome | Base | example | Procedure Outcome Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.complication | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| Procedure.followUp | Base | example | Procedure Follow up Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.focalDevice.action | Base | preferred | Procedure Device Action Codes | 📍4.0.1 | FHIR Std. |
| Procedure.usedCode | Base | example | FHIR Device Types | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Procedure |
|||
| status |
|
|
|
| statusReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| category |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| code |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| subject |
|
|
|
| encounter |
|
|
|
| performed[x] |
|
|
|
| performer |
|||
| function |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| reasonReference |
|
|
|
| bodySite |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| outcome |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| complication |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| followUp |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| focalDevice |
|||
| action |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| usedCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Summary
Must-Support: 38 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron