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/UP-Manila-SILab/PhilHealth-NHDR-IG-Review/ 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 Specification

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.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* Provenance Who, What, When for a set of resources
Provenance.target This element is included in summaries. 1..* Reference(Resource) Target Reference(s) (usually version specific)
Provenance.recorded This element is included in summaries. 1..1 instant When the activity was recorded / updated
Provenance.agent 1..* BackboneElement Actor involved
Provenance.agent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.agent.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
Provenance.signature 0..* PH_Signature Signature on target

doco 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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* Provenance Who, What, When for a set of resources
Provenance.meta
Provenance.meta.Slices for extension Content/Rules for all slices
Provenance.meta.Slices for extension.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
Provenance.meta.Slices for extension.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
Provenance.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
Provenance.implicitRules 0..0 A set of rules under which this content was created
Provenance.language 0..0 Language of the resource content
Provenance.contained 0..0 Contained, inline Resources
Provenance.extension 0..0 Extension
Provenance.modifierExtension 0..0 Extension
Provenance.occurred[x] 0..0 When the activity occurred
Provenance.policy 0..0 Policy or plan the activity was defined by
Provenance.location 0..0 Where the activity occurred, if relevant
Provenance.reason 0..0 Reason the activity is occurring
Provenance.activity 0..0 Activity that occurred
Provenance.agent
Provenance.agent.id 0..0 Unique id for inter-element referencing
Provenance.agent.type 0..0 How the agent participated
Provenance.agent.role 0..0 What the agents role was
Provenance.agent.onBehalfOf 0..0 Who the agent is representing
Provenance.entity 0..0 An entity used in this activity
Provenance.signature 0..* PH_Signature Signature on target

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* Provenance Who, What, When for a set of resources
Provenance.id This element is included in summaries. 0..1 id Logical id of this artifact
Provenance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Provenance.meta.id 0..1 string Unique id for inter-element referencing
Provenance.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Provenance.meta.Slices for extension.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
Provenance.meta.Slices for extension.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
Provenance.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Provenance.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
Provenance.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Provenance.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Provenance.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Provenance.meta.tag This element is included in summaries. 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".
Provenance.target This element is included in summaries. 1..* Reference(Resource) Target Reference(s) (usually version specific)
Provenance.recorded This element is included in summaries. 1..1 instant When the activity was recorded / updated
Provenance.agent 1..* BackboneElement Actor involved
Provenance.agent.extension 0..* Extension Additional content defined by implementations
Provenance.agent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.agent.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
Provenance.signature 0..* PH_Signature Signature on target

doco 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:

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* Provenance Who, What, When for a set of resources
Provenance.target This element is included in summaries. 1..* Reference(Resource) Target Reference(s) (usually version specific)
Provenance.recorded This element is included in summaries. 1..1 instant When the activity was recorded / updated
Provenance.agent 1..* BackboneElement Actor involved
Provenance.agent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.agent.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
Provenance.signature 0..* PH_Signature Signature on target

doco 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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* Provenance Who, What, When for a set of resources
Provenance.meta
Provenance.meta.Slices for extension Content/Rules for all slices
Provenance.meta.Slices for extension.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
Provenance.meta.Slices for extension.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
Provenance.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
Provenance.implicitRules 0..0 A set of rules under which this content was created
Provenance.language 0..0 Language of the resource content
Provenance.text 0..0 Text summary of the resource, for human interpretation
Provenance.contained 0..0 Contained, inline Resources
Provenance.extension 0..0 Extension
Provenance.modifierExtension 0..0 Extension
Provenance.occurred[x] 0..0 When the activity occurred
Provenance.policy 0..0 Policy or plan the activity was defined by
Provenance.location 0..0 Where the activity occurred, if relevant
Provenance.reason 0..0 Reason the activity is occurring
Provenance.activity 0..0 Activity that occurred
Provenance.agent
Provenance.agent.id 0..0 Unique id for inter-element referencing
Provenance.agent.type 0..0 How the agent participated
Provenance.agent.role 0..0 What the agents role was
Provenance.agent.onBehalfOf 0..0 Who the agent is representing
Provenance.entity 0..0 An entity used in this activity
Provenance.signature 0..* PH_Signature Signature on target

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Provenance 0..* Provenance Who, What, When for a set of resources
Provenance.id This element is included in summaries. 0..1 id Logical id of this artifact
Provenance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Provenance.meta.id 0..1 string Unique id for inter-element referencing
Provenance.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Provenance.meta.Slices for extension.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
Provenance.meta.Slices for extension.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
Provenance.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Provenance.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
Provenance.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Provenance.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Provenance.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Provenance.meta.tag This element is included in summaries. 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".
Provenance.target This element is included in summaries. 1..* Reference(Resource) Target Reference(s) (usually version specific)
Provenance.recorded This element is included in summaries. 1..1 instant When the activity was recorded / updated
Provenance.agent 1..* BackboneElement Actor involved
Provenance.agent.extension 0..* Extension Additional content defined by implementations
Provenance.agent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Provenance.agent.who This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated
Provenance.signature 0..* PH_Signature Signature on target

doco 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:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron