NHDR Implementation Guide Release 1.0
0.1.0 - ci-build

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/PROJ-PHILHEALTH-EA-NHDR/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:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on a patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:illnessClass 0..* CodeableConcept Illness Class
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IllnessClass
... 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)
... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
From the FHIR Standard
Procedure.coderequiredProcedureCodeVS(a valid code from Relative Value Scale (RVS) Codes)
https://nhdr.gov.ph/fhir/ValueSet/ProcedureCodeVS
From this IG
Procedure.outcomerequiredHl7VSPatientOutcome
http://terminology.hl7.org/ValueSet/v2-0241

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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-4errorProcedureIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure Procedure
... meta
.... Slices for extension Content/Rules for all slices
..... extension:recordedDate 0..* dateTime Date recorded
URL: https://nhdr.gov.ph/fhir/StructureDefinition/RecordedDate
... implicitRules 0..0
... language 0..0
... text 0..0
... contained 0..0
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:illnessClass 0..* CodeableConcept Illness Class
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IllnessClass
... modifierExtension 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..0
... partOf 0..0
... statusReason 0..0
... 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
... asserter 0..0
... performer
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... function 0..0
... location 0..0
... reasonReference 0..0
... outcome 0..1 CodeableConcept The result of procedure
Binding: hl7VS-patientOutcome (required)
... report 0..0
... complication 0..0
... complicationDetail 0..0
... followUp 0..0
... focalDevice 0..0
... usedReference 0..0
... usedCode 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Procedure.coderequiredProcedureCodeVS(a valid code from Relative Value Scale (RVS) Codes)
https://nhdr.gov.ph/fhir/ValueSet/ProcedureCodeVS
From this IG
Procedure.outcomerequiredHl7VSPatientOutcome
http://terminology.hl7.org/ValueSet/v2-0241
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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:recordedDate 0..* dateTime Date recorded
URL: https://nhdr.gov.ph/fhir/StructureDefinition/RecordedDate
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... 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".
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:illnessClass 0..* CodeableConcept Illness Class
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IllnessClass
... 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
.... onBehalfOf 0..1 Reference(Organization) Organization the device or practitioner was acting for
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Procedure.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
From the FHIR Standard
Procedure.categoryexampleProcedureCategoryCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-category
From the FHIR Standard
Procedure.coderequiredProcedureCodeVS(a valid code from Relative Value Scale (RVS) Codes)
https://nhdr.gov.ph/fhir/ValueSet/ProcedureCodeVS
From this IG
Procedure.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
From the FHIR Standard
Procedure.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
Procedure.outcomerequiredHl7VSPatientOutcome
http://terminology.hl7.org/ValueSet/v2-0241
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
http://hl7.org/fhir/ValueSet/device-action
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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-4errorProcedureIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Procedure

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure 0..* Procedure An action that is being or was performed on a patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:illnessClass 0..* CodeableConcept Illness Class
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IllnessClass
... 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)
... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
From the FHIR Standard
Procedure.coderequiredProcedureCodeVS(a valid code from Relative Value Scale (RVS) Codes)
https://nhdr.gov.ph/fhir/ValueSet/ProcedureCodeVS
From this IG
Procedure.outcomerequiredHl7VSPatientOutcome
http://terminology.hl7.org/ValueSet/v2-0241

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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-4errorProcedureIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Procedure Procedure
... meta
.... Slices for extension Content/Rules for all slices
..... extension:recordedDate 0..* dateTime Date recorded
URL: https://nhdr.gov.ph/fhir/StructureDefinition/RecordedDate
... implicitRules 0..0
... language 0..0
... text 0..0
... contained 0..0
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:illnessClass 0..* CodeableConcept Illness Class
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IllnessClass
... modifierExtension 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..0
... partOf 0..0
... statusReason 0..0
... 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
... asserter 0..0
... performer
.... id 0..0
.... extension 0..0
.... modifierExtension 0..0
.... function 0..0
... location 0..0
... reasonReference 0..0
... outcome 0..1 CodeableConcept The result of procedure
Binding: hl7VS-patientOutcome (required)
... report 0..0
... complication 0..0
... complicationDetail 0..0
... followUp 0..0
... focalDevice 0..0
... usedReference 0..0
... usedCode 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Procedure.coderequiredProcedureCodeVS(a valid code from Relative Value Scale (RVS) Codes)
https://nhdr.gov.ph/fhir/ValueSet/ProcedureCodeVS
From this IG
Procedure.outcomerequiredHl7VSPatientOutcome
http://terminology.hl7.org/ValueSet/v2-0241

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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:recordedDate 0..* dateTime Date recorded
URL: https://nhdr.gov.ph/fhir/StructureDefinition/RecordedDate
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... 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".
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:illnessClass 0..* CodeableConcept Illness Class
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IllnessClass
... 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
.... onBehalfOf 0..1 Reference(Organization) Organization the device or practitioner was acting for
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Procedure.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
From the FHIR Standard
Procedure.categoryexampleProcedureCategoryCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-category
From the FHIR Standard
Procedure.coderequiredProcedureCodeVS(a valid code from Relative Value Scale (RVS) Codes)
https://nhdr.gov.ph/fhir/ValueSet/ProcedureCodeVS
From this IG
Procedure.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
From the FHIR Standard
Procedure.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
Procedure.outcomerequiredHl7VSPatientOutcome
http://terminology.hl7.org/ValueSet/v2-0241
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
http://hl7.org/fhir/ValueSet/device-action
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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-4errorProcedureIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Procedure

 

Other representations of profile: CSV, Excel, Schematron