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/nhdr-fhir-ig-review-project-2/ and changes regularly. See the Directory of published versions

## Resource Profile: PH Provenance

Official URL: https://nhdr.gov.ph/fhir/StructureDefinition/PH-Provenance | Version: 0.1.0
Standards status: Draft | Computable Name: PH_Provenance
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

Usages:

- This Profile is not used by any profiles in this Implementation Guide

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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | Provenance | Who, What, When for a set of resources
target | Σ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific)
recorded | Σ | 1..1 | instant | When the activity was recorded / updated
agent |  | 1..* | BackboneElement | Actor involved
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
who | Σ | 1..1 | Reference(PH Practitioner | PH PractitionerRole | PH RelatedPerson | PH Patient | PH Organization) | Who participated
signature |  | 0..* | PH_Signature | Signature on target
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Provenance | 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 | Provenance | 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 | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Provenance | 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 Provenance

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | Provenance | Who, What, When for a set of resources
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
occurred[x] |  | 0..0 |  | When the activity occurred
policy |  | 0..0 |  | Policy or plan the activity was defined by
location |  | 0..0 |  | Where the activity occurred, if relevant
reason |  | 0..0 |  | Reason the activity is occurring
activity |  | 0..0 |  | Activity that occurred
agent |  |  |  |
id |  | 0..0 |  | Unique id for inter-element referencing
type |  | 0..0 |  | How the agent participated
role |  | 0..0 |  | What the agents role was
who |  | 1..1 | Reference(PH Practitioner | PH PractitionerRole | PH RelatedPerson | PH Patient | PH Organization) | Who participated
onBehalfOf |  | 0..0 |  | Who the agent is representing
entity |  | 0..0 |  | An entity used in this activity
signature |  | 0..* | PH_Signature | Signature on target
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | Provenance | Who, What, When for a set of resources
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".
target | Σ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific)
recorded | Σ | 1..1 | instant | When the activity was recorded / updated
agent |  | 1..* | BackboneElement | Actor involved
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
who | Σ | 1..1 | Reference(PH Practitioner | PH PractitionerRole | PH RelatedPerson | PH Patient | PH Organization) | Who participated
signature |  | 0..* | PH_Signature | Signature on target
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Provenance.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
Provenance.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Provenance | 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 | Provenance | 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 | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Provenance | 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 Provenance

Summary

Prohibited: 16 elements

Structures

This structure refers to these other structures:

- PH Practitioner (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Practitioner)
- PH PractitionerRole (https://nhdr.gov.ph/fhir/StructureDefinition/PH-PractitionerRole)
- PH RelatedPerson (https://nhdr.gov.ph/fhir/StructureDefinition/PH-RelatedPerson)
- PH Patient (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Patient)
- PH Organization (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Organization)
- PH Signature (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Signature)

Extensions

This structure refers to these extensions:

- https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
- https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | Provenance | Who, What, When for a set of resources
target | Σ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific)
recorded | Σ | 1..1 | instant | When the activity was recorded / updated
agent |  | 1..* | BackboneElement | Actor involved
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
who | Σ | 1..1 | Reference(PH Practitioner | PH PractitionerRole | PH RelatedPerson | PH Patient | PH Organization) | Who participated
signature |  | 0..* | PH_Signature | Signature on target
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Provenance | 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 | Provenance | 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 | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Provenance | 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 Provenance

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | Provenance | Who, What, When for a set of resources
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
occurred[x] |  | 0..0 |  | When the activity occurred
policy |  | 0..0 |  | Policy or plan the activity was defined by
location |  | 0..0 |  | Where the activity occurred, if relevant
reason |  | 0..0 |  | Reason the activity is occurring
activity |  | 0..0 |  | Activity that occurred
agent |  |  |  |
id |  | 0..0 |  | Unique id for inter-element referencing
type |  | 0..0 |  | How the agent participated
role |  | 0..0 |  | What the agents role was
who |  | 1..1 | Reference(PH Practitioner | PH PractitionerRole | PH RelatedPerson | PH Patient | PH Organization) | Who participated
onBehalfOf |  | 0..0 |  | Who the agent is representing
entity |  | 0..0 |  | An entity used in this activity
signature |  | 0..* | PH_Signature | Signature on target
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Provenance |  | 0..* | Provenance | Who, What, When for a set of resources
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".
target | Σ | 1..* | Reference(Resource) | Target Reference(s) (usually version specific)
recorded | Σ | 1..1 | instant | When the activity was recorded / updated
agent |  | 1..* | BackboneElement | Actor involved
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
who | Σ | 1..1 | Reference(PH Practitioner | PH PractitionerRole | PH RelatedPerson | PH Patient | PH Organization) | Who participated
signature |  | 0..* | PH_Signature | Signature on target
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Provenance.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
Provenance.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
Provenance.entity.role | Base | required | ProvenanceEntityRole | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Provenance | 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 | Provenance | 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 | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Provenance | 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 Provenance

Summary

Prohibited: 16 elements

Structures

This structure refers to these other structures:

- PH Practitioner (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Practitioner)
- PH PractitionerRole (https://nhdr.gov.ph/fhir/StructureDefinition/PH-PractitionerRole)
- PH RelatedPerson (https://nhdr.gov.ph/fhir/StructureDefinition/PH-RelatedPerson)
- PH Patient (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Patient)
- PH Organization (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Organization)
- PH Signature (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Signature)

Extensions

This structure refers to these extensions:

- https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
- https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated

Other representations of profile: CSV, Excel, Schematron