NHDR Implementation Guide Release 1.0, published by NHDR. 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/UP-Manila-SILab/PhilHealth-NHDR-IG-Review/ and changes regularly. See the Directory of published versions
Resource Profile: PH Procedure
| Official URL: https://nhdr.gov.ph/fhir/StructureDefinition/PH-Procedure | Version: 0.1.0 | |||
| Standards status: Draft | Computable Name: PH_Procedure | |||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
||||
An action that is or was performed on or for a patient, practitioner, device, organization, or location.
Usages:
- Refer to this Profile: PH Encounter
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.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Procedure |
0..* | Procedure | An action that is being or was performed on a patient | |
  status |
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. | |
 code |
0..1 | CodeableConcept | Identification of the procedure Binding: Procedure Code (required) | |
 subject |
1..1 | Reference(PH Patient) | Who the procedure was performed on | |
| encounter |
0..1 | Reference(PH Encounter) | Encounter created as part of | |
  performed[x] |
0..1 | When the procedure was performed | ||
 performedDateTime |
dateTime | |||
 performedPeriod |
Period | |||
| outcome |
0..1 | CodeableConcept | The result of procedure Binding: hl7VS-patientOutcome (required) | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Procedure.code | Base | required | Procedure Code | 📦0.1.0 | This IG |
| Procedure.outcome | Base | required | hl7VS-patientOutcome | 📦3.0.0 | THO v7.4 |
Constraints
| 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()
|
This structure is derived from Procedure
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Procedure |
0..* | Procedure | An action that is being or was performed on a patient | |
 meta |
||||
 Slices for extension |
Content/Rules for all slices | |||
  extension:hfRecordedDate |
0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate | |
 extension:hfLastUpdated |
0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated | |
| lastUpdated |
0..1 | instant | When the resource was uploaded to the NHDR. | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
 extension |
0..0 | Extension | ||
 modifierExtension |
0..0 | Extension | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| basedOn |
0..0 | A request for this procedure | ||
| partOf |
0..0 | Part of referenced event | ||
| statusReason |
0..0 | Reason for current status | ||
| code |
0..1 | CodeableConcept | Identification of the procedure Binding: Procedure Code (required) | |
| subject |
1..1 | Reference(PH Patient) | Who the procedure was performed on | |
| encounter |
0..1 | Reference(PH Encounter) | Encounter created as part of | |
| performed[x] |
0..1 | When the procedure was performed | ||
| performedDateTime |
dateTime | |||
| performedPeriod |
Period | |||
| recorder |
0..0 | Who recorded the procedure | ||
| asserter |
0..0 | Person who asserts this procedure | ||
| performer |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| function |
0..0 | Type of performance | ||
| onBehalfOf |
0..0 | Organization the device or practitioner was acting for | ||
| location |
0..0 | Where the procedure happened | ||
| reasonReference |
0..0 | The justification that the procedure was performed | ||
| outcome |
0..1 | CodeableConcept | The result of procedure Binding: hl7VS-patientOutcome (required) | |
| report |
0..0 | Any report resulting from the procedure | ||
| complication |
0..0 | Complication following the procedure | ||
| complicationDetail |
0..0 | A condition that is a result of the procedure | ||
| followUp |
0..0 | Instructions for follow up | ||
| focalDevice |
0..0 | Manipulated, implanted, or removed device | ||
| usedReference |
0..0 | Items used during procedure | ||
| usedCode |
0..0 | Coded items used during the procedure | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.code | Base | required | Procedure Code | 📦0.1.0 | This IG |
| Procedure.outcome | Base | required | hl7VS-patientOutcome | 📦3.0.0 | THO v7.4 |
| 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 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:hfRecordedDate |
0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate | |
| extension:hfLastUpdated |
0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated | |
| versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource was uploaded to the NHDR. | |
| source |
0..1 | uri | Identifies where the resource comes from | |
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |
| identifier |
0..* | Identifier | External Identifiers for this procedure | |
| status |
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 |
0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. | |
| code |
0..1 | CodeableConcept | Identification of the procedure Binding: Procedure Code (required) | |
| subject |
1..1 | Reference(PH Patient) | Who the procedure was performed on | |
| encounter |
0..1 | Reference(PH Encounter) | Encounter created as part of | |
| performed[x] |
0..1 | When the procedure was performed | ||
| performedDateTime |
dateTime | |||
| performedPeriod |
Period | |||
| performer |
0..* | BackboneElement | The people who performed the procedure | |
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner | |
| reasonCode |
0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. | |
| bodySite |
0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
| outcome |
0..1 | CodeableConcept | The result of procedure Binding: hl7VS-patientOutcome (required) | |
| note |
0..* | Annotation | Additional information about the procedure | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Procedure.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Procedure.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Procedure.category | Base | example | Procedure Category Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.code | Base | required | Procedure Code | 📦0.1.0 | This IG |
| 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 | required | hl7VS-patientOutcome | 📦3.0.0 | THO v7.4 |
| Procedure.focalDevice.action | Base | preferred | Procedure Device Action Codes | 📍4.0.1 | FHIR Std. |
Constraints
| 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()
|
This structure is derived from Procedure
Summary
Prohibited: 27 elements
Structures
This structure refers to these other structures:
- PH Patient (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Patient)
- PH Encounter (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Encounter)
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Procedure |
0..* | Procedure | An action that is being or was performed on a patient | |
| status |
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. | |
| code |
0..1 | CodeableConcept | Identification of the procedure Binding: Procedure Code (required) | |
| subject |
1..1 | Reference(PH Patient) | Who the procedure was performed on | |
| encounter |
0..1 | Reference(PH Encounter) | Encounter created as part of | |
| performed[x] |
0..1 | When the procedure was performed | ||
| performedDateTime |
dateTime | |||
| performedPeriod |
Period | |||
| outcome |
0..1 | CodeableConcept | The result of procedure Binding: hl7VS-patientOutcome (required) | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Procedure.code | Base | required | Procedure Code | 📦0.1.0 | This IG |
| Procedure.outcome | Base | required | hl7VS-patientOutcome | 📦3.0.0 | THO v7.4 |
Constraints
| 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
This structure is derived from Procedure
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Procedure |
0..* | Procedure | An action that is being or was performed on a patient | |
| meta |
||||
| Slices for extension |
Content/Rules for all slices | |||
| extension:hfRecordedDate |
0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate | |
| extension:hfLastUpdated |
0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated | |
| lastUpdated |
0..1 | instant | When the resource was uploaded to the NHDR. | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| text |
0..0 | Text summary of the resource, for human interpretation | ||
| contained |
0..0 | Contained, inline Resources | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| basedOn |
0..0 | A request for this procedure | ||
| partOf |
0..0 | Part of referenced event | ||
| statusReason |
0..0 | Reason for current status | ||
| code |
0..1 | CodeableConcept | Identification of the procedure Binding: Procedure Code (required) | |
| subject |
1..1 | Reference(PH Patient) | Who the procedure was performed on | |
| encounter |
0..1 | Reference(PH Encounter) | Encounter created as part of | |
| performed[x] |
0..1 | When the procedure was performed | ||
| performedDateTime |
dateTime | |||
| performedPeriod |
Period | |||
| recorder |
0..0 | Who recorded the procedure | ||
| asserter |
0..0 | Person who asserts this procedure | ||
| performer |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| function |
0..0 | Type of performance | ||
| onBehalfOf |
0..0 | Organization the device or practitioner was acting for | ||
| location |
0..0 | Where the procedure happened | ||
| reasonReference |
0..0 | The justification that the procedure was performed | ||
| outcome |
0..1 | CodeableConcept | The result of procedure Binding: hl7VS-patientOutcome (required) | |
| report |
0..0 | Any report resulting from the procedure | ||
| complication |
0..0 | Complication following the procedure | ||
| complicationDetail |
0..0 | A condition that is a result of the procedure | ||
| followUp |
0..0 | Instructions for follow up | ||
| focalDevice |
0..0 | Manipulated, implanted, or removed device | ||
| usedReference |
0..0 | Items used during procedure | ||
| usedCode |
0..0 | Coded items used during the procedure | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.code | Base | required | Procedure Code | 📦0.1.0 | This IG |
| Procedure.outcome | Base | required | hl7VS-patientOutcome | 📦3.0.0 | THO v7.4 |
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 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:hfRecordedDate |
0..1 | dateTime | The recorded date indicating when the record was uploaded by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate | |
| extension:hfLastUpdated |
0..* | dateTime | The date indicating when the record was last updated by the health facility. URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated | |
| versionId |
0..1 | id | Version specific identifier | |
| lastUpdated |
0..1 | instant | When the resource was uploaded to the NHDR. | |
| source |
0..1 | uri | Identifies where the resource comes from | |
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |
| identifier |
0..* | Identifier | External Identifiers for this procedure | |
| status |
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 |
0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. | |
| code |
0..1 | CodeableConcept | Identification of the procedure Binding: Procedure Code (required) | |
| subject |
1..1 | Reference(PH Patient) | Who the procedure was performed on | |
| encounter |
0..1 | Reference(PH Encounter) | Encounter created as part of | |
| performed[x] |
0..1 | When the procedure was performed | ||
| performedDateTime |
dateTime | |||
| performedPeriod |
Period | |||
| performer |
0..* | BackboneElement | The people who performed the procedure | |
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner | |
| reasonCode |
0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. | |
| bodySite |
0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
| outcome |
0..1 | CodeableConcept | The result of procedure Binding: hl7VS-patientOutcome (required) | |
| note |
0..* | Annotation | Additional information about the procedure | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Procedure.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Procedure.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Procedure.category | Base | example | Procedure Category Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| Procedure.code | Base | required | Procedure Code | 📦0.1.0 | This IG |
| 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 | required | hl7VS-patientOutcome | 📦3.0.0 | THO v7.4 |
| Procedure.focalDevice.action | Base | preferred | Procedure Device Action Codes | 📍4.0.1 | FHIR Std. |
Constraints
| 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()
|
This structure is derived from Procedure
Summary
Prohibited: 27 elements
Structures
This structure refers to these other structures:
- PH Patient (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Patient)
- PH Encounter (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Encounter)
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron