Draft PH Core Implementation Guide
0.2.0 - ci-build Philippines flag

Draft PH Core Implementation Guide - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PHCoreProvenance - Detailed Descriptions

Draft as of 2026-04-10

Definitions for the ph-core-provenance resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Provenance
Definition

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.

ShortWho, What, When for a set of resources
Comments

Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.

Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesHistory, Event, Activity
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Provenance.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Provenance.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Provenance.target
Definition

The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by a single activity.


The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.

ShortThe Resource(s) this Provenance record supportsTarget Reference(s) (usually version specific)
Comments

See the PH Core Provenance Profile for guidance on supported resource types.


Target references are usually version specific, but might not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource might not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion.

Control1..*
TypeReference(Resource)
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Provenance.target.reference
Definition

A reference to another resource on the FHIR server.


A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

ShortLiteral reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control0..1
This element is affected by the following invariants: ref-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Provenance.recorded
Definition

The instant of time at which the activity was recorded.

ShortTimestamp when the activity was recorded / updatedWhen the activity was recorded / updated
Comments

This is when the activity was recorded, not necessarily when it occurred.


This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource.

Control1..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Provenance.location
Definition

Where the activity occurred, if relevant.

ShortWhere the activity occurred, if relevant
Control0..1
TypeReference(PH Core Location, Location)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Provenance.reason
Definition

The reason that the activity was taking place.

ShortReason the activity is occurring
Control0..*
BindingUnless not suitable, these codes SHALL be taken from PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse
(extensible to http://terminology.hl7.org/ValueSet/v3-PurposeOfUse)

The reason the activity took place.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Obligations
    ObligationsActor
    SHALL:handlePH Core Server
    SHALL:handlePH Core Consumer
    MAY:able-to-populatePH Core Creator
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Provenance.reason.coding
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control0..*
    TypeCoding
    Is Modifierfalse
    Must Supporttrue
    Obligations
      ObligationsActor
      SHALL:handlePH Core Server
      SHALL:handlePH Core Consumer
      MAY:able-to-populatePH Core Creator
      Summarytrue
      Requirements

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. Provenance.reason.text
      Definition

      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      ShortPlain text representation of the concept
      Comments

      Very often the text is the same as a displayName of one of the codings.

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Obligations
        ObligationsActor
        SHALL:handlePH Core Server
        SHALL:handlePH Core Consumer
        MAY:able-to-populatePH Core Creator
        Summarytrue
        Requirements

        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. Provenance.activity
        Definition

        An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.

        ShortActivity that occurred
        Control0..1
        BindingUnless not suitable, these codes SHALL be taken from ProvenanceActivityTypehttp://hl7.org/fhir/ValueSet/provenance-activity-type|4.0.1
        (extensible to http://hl7.org/fhir/ValueSet/provenance-activity-type|4.0.1)

        The activity that took place.

        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Obligations
          ObligationsActor
          SHALL:handlePH Core Server
          SHALL:handlePH Core Consumer
          MAY:able-to-populatePH Core Creator
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          22. Provenance.activity.coding
          Definition

          A reference to a code defined by a terminology system.

          ShortCode defined by a terminology system
          Comments

          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

          Control0..*
          TypeCoding
          Is Modifierfalse
          Must Supporttrue
          Obligations
            ObligationsActor
            SHALL:handlePH Core Server
            SHALL:handlePH Core Consumer
            MAY:able-to-populatePH Core Creator
            Summarytrue
            Requirements

            Allows for alternative encodings within a code system, and translations to other code systems.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            24. Provenance.activity.text
            Definition

            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

            ShortPlain text representation of the concept
            Comments

            Very often the text is the same as a displayName of one of the codings.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Obligations
              ObligationsActor
              SHALL:handlePH Core Server
              SHALL:handlePH Core Consumer
              MAY:able-to-populatePH Core Creator
              Summarytrue
              Requirements

              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              26. Provenance.agent
              Definition

              An actor that takes part in the activity. The actor can be a person, an organization, a device, or a software system.


              An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

              ShortActor(s) involvedActor involved
              Comments

              At least one agent must be provided. Use the ProvenanceAuthor slice for the entity that created the content and ProvenanceTransmitter slice for the entity that sent/transmitted it.


              Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.

              Control1..*
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Requirements

              An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device (who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists())
              SlicingThis element introduces a set of slices on Provenance.agent. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ type
              • 28. Provenance.agent.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                30. Provenance.agent.type
                Definition

                The participation the agent had in the activity.


                The participation the agent had with respect to the activity.

                ShortHow the agent participated
                Comments

                For example: author, performer, enterer, attester, etc.

                Control0..1
                BindingUnless not suitable, these codes SHALL be taken from ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-type|4.0.1
                (extensible to http://hl7.org/fhir/ValueSet/provenance-agent-type)

                The type of participation (author, transmitter, etc.)


                The type of participation that a provenance agent played with respect to the activity.

                TypeCodeableConcept
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                32. Provenance.agent.role
                Definition

                The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

                ShortWhat the agents role was
                Comments

                For example: doctor, nurse, clerk, etc.

                Control0..*
                BindingFor example codes, see SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type|4.0.1
                (example to http://hl7.org/fhir/ValueSet/security-role-type|4.0.1)

                The role that a provenance agent played with respect to the activity.

                TypeCodeableConcept
                Is Modifierfalse
                Must Supporttrue
                Obligations
                  ObligationsActor
                  SHALL:handlePH Core Server
                  SHALL:handlePH Core Consumer
                  MAY:able-to-populatePH Core Creator
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  34. Provenance.agent.role.coding
                  Definition

                  A reference to a code defined by a terminology system.

                  ShortCode defined by a terminology system
                  Comments

                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                  Control0..*
                  TypeCoding
                  Is Modifierfalse
                  Must Supporttrue
                  Obligations
                    ObligationsActor
                    SHALL:handlePH Core Server
                    SHALL:handlePH Core Consumer
                    MAY:able-to-populatePH Core Creator
                    Summarytrue
                    Requirements

                    Allows for alternative encodings within a code system, and translations to other code systems.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    36. Provenance.agent.role.text
                    Definition

                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                    ShortPlain text representation of the concept
                    Comments

                    Very often the text is the same as a displayName of one of the codings.

                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Obligations
                      ObligationsActor
                      SHALL:handlePH Core Server
                      SHALL:handlePH Core Consumer
                      MAY:able-to-populatePH Core Creator
                      Summarytrue
                      Requirements

                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      38. Provenance.agent.who
                      Definition

                      The individual, organization, or device that participated in the activity.


                      The individual, device or organization that participated in the event.

                      ShortWho participated
                      Comments

                      whoIdentity should be used when the agent is not a Resource type.

                      Control1..1
                      TypeReference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization)
                      Is Modifierfalse
                      Must Supporttrue
                      Must Support TypesNo must-support rules about the choice of types/profiles
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      40. Provenance.agent.onBehalfOf
                      Definition

                      The organization the agent is representing. This is mandatory when the agent is a Practitioner or Device.


                      The individual, device, or organization for whom the change was made.

                      ShortWho the agent is representing
                      Comments

                      When the agent is a Practitioner or Device, this element identifies the organization they were acting on behalf of.


                      onBehalfOfIdentity should be used when the agent is not a Resource type.

                      Control0..1
                      TypeReference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization)
                      Is Modifierfalse
                      Must Supporttrue
                      Must Support TypesNo must-support rules about the choice of types/profiles
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      42. Provenance.agent:ProvenanceAuthor
                      Slice NameProvenanceAuthor
                      Definition

                      The entity that created the data. This is typically an organization, practitioner, patient, or device that authored the information.


                      An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

                      ShortAuthor organization or individual responsible for the informationActor involved
                      Comments

                      The author is the source of the information being recorded. This slice is used to identify who originally created the content.

                      Referenced Profiles:

                      • PHCorePractitioner: Philippine healthcare practitioner
                      • PHCorePractitionerRole: Practitioner in a specific role
                      • PHCoreOrganization: Philippine healthcare organization
                      • PHCorePatient: Philippine patient
                      • PHCoreRelatedPerson: Related person (family member, guardian, etc.)
                      • Device: Base FHIR Device (no PH Core Device profile)

                      Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.

                      Control01..*
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      44. Provenance.agent:ProvenanceAuthor.modifierExtension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                      ShortExtensions that cannot be ignored even if unrecognized
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      Requirements

                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                      Alternate Namesextensions, user content, modifiers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      46. Provenance.agent:ProvenanceAuthor.type
                      Definition

                      The type of agent participation. For the author slice, this is fixed to 'author'.


                      The participation the agent had with respect to the activity.

                      ShortHow the agent participated
                      Comments

                      Fixed value: author


                      For example: author, performer, enterer, attester, etc.

                      Control10..1
                      BindingUnless not suitable, these codes SHALL be taken from ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-type|4.0.1
                      (extensible to http://hl7.org/fhir/ValueSet/provenance-agent-type)

                      The type of participation (author, transmitter, etc.)


                      The type of participation that a provenance agent played with respect to the activity.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Pattern Value{
                        "coding" : [{
                          "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                          "code" : "author"
                        }]
                      }
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      48. Provenance.agent:ProvenanceAuthor.role
                      Definition

                      The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

                      ShortWhat the agents role was
                      Comments

                      For example: doctor, nurse, clerk, etc.

                      Control0..*
                      BindingFor example codes, see SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type|4.0.1
                      (example to http://hl7.org/fhir/ValueSet/security-role-type|4.0.1)

                      The role that a provenance agent played with respect to the activity.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      50. Provenance.agent:ProvenanceAuthor.role.coding
                      Definition

                      A reference to a code defined by a terminology system.

                      ShortCode defined by a terminology system
                      Comments

                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                      Control0..*
                      TypeCoding
                      Is Modifierfalse
                      Must Supporttrue
                      Obligations
                        ObligationsActor
                        SHALL:handlePH Core Server
                        SHALL:handlePH Core Consumer
                        MAY:able-to-populatePH Core Creator
                        Summarytrue
                        Requirements

                        Allows for alternative encodings within a code system, and translations to other code systems.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        52. Provenance.agent:ProvenanceAuthor.role.text
                        Definition

                        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                        ShortPlain text representation of the concept
                        Comments

                        Very often the text is the same as a displayName of one of the codings.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Obligations
                          ObligationsActor
                          SHALL:handlePH Core Server
                          SHALL:handlePH Core Consumer
                          MAY:able-to-populatePH Core Creator
                          Summarytrue
                          Requirements

                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          54. Provenance.agent:ProvenanceAuthor.who
                          Definition

                          The individual, organization, or device that authored the information.


                          The individual, device or organization that participated in the event.

                          ShortWho participated
                          Comments

                          References PH Core profiles where available:

                          • PHCorePractitioner | PHCorePractitionerRole | PHCoreOrganization | PHCorePatient | PHCoreRelatedPerson Uses base FHIR Device when no PH Core profile exists.

                          whoIdentity should be used when the agent is not a Resource type.

                          Control1..1
                          TypeReference(PH Core Practitioner, PH Core PractitionerRole, PH Core Organization, PH Core Patient, PH Core RelatedPerson, Device, Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization)
                          Is Modifierfalse
                          Must Supporttrue
                          Must Support TypesNo must-support rules about the choice of types/profiles
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          56. Provenance.agent:ProvenanceAuthor.onBehalfOf
                          Definition

                          The organization the agent is representing. This is mandatory when the agent is a Practitioner or Device (per provenance-1 constraint).


                          The individual, device, or organization for whom the change was made.

                          ShortWho the agent is representing
                          Comments

                          References PHCoreOrganization


                          onBehalfOfIdentity should be used when the agent is not a Resource type.

                          Control0..1
                          TypeReference(PH Core Organization, Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization)
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          58. Provenance.agent:ProvenanceTransmitter
                          Slice NameProvenanceTransmitter
                          Definition

                          The entity that transmitted the data from the source to the destination. If the transmitter is a device, the transmitter organization must also be valued.


                          An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

                          ShortTransmitter that provided the informationActor involved
                          Comments

                          The transmitter represents who sent the information, which may differ from who authored it. This is important for tracking the chain of custody.

                          Referenced Profiles:

                          • PHCorePractitioner: Philippine healthcare practitioner
                          • PHCorePractitionerRole: Practitioner in a specific role
                          • PHCoreOrganization: Philippine healthcare organization
                          • PHCorePatient: Philippine patient
                          • PHCoreRelatedPerson: Related person (family member, guardian, etc.)
                          • Device: Base FHIR Device (no PH Core Device profile)

                          Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.

                          Control01..*
                          TypeBackboneElement
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          Requirements

                          An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          60. Provenance.agent:ProvenanceTransmitter.modifierExtension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                          ShortExtensions that cannot be ignored even if unrecognized
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                          Summarytrue
                          Requirements

                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                          Alternate Namesextensions, user content, modifiers
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          62. Provenance.agent:ProvenanceTransmitter.type
                          Definition

                          The type of agent participation. For the transmitter slice, this is fixed to 'transmitter'.


                          The participation the agent had with respect to the activity.

                          ShortHow the agent participated
                          Comments

                          Fixed value: transmitter


                          For example: author, performer, enterer, attester, etc.

                          Control10..1
                          BindingUnless not suitable, these codes SHALL be taken from ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-type|4.0.1
                          (extensible to http://hl7.org/fhir/ValueSet/provenance-agent-type)

                          The type of participation (author, transmitter, etc.)


                          The type of participation that a provenance agent played with respect to the activity.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Must Supporttrue
                          Summarytrue
                          Pattern Value{
                            "coding" : [{
                              "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                              "code" : "transmitter"
                            }]
                          }
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          64. Provenance.agent:ProvenanceTransmitter.role
                          Definition

                          The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

                          ShortWhat the agents role was
                          Comments

                          For example: doctor, nurse, clerk, etc.

                          Control0..*
                          BindingFor example codes, see SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type|4.0.1
                          (example to http://hl7.org/fhir/ValueSet/security-role-type|4.0.1)

                          The role that a provenance agent played with respect to the activity.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          66. Provenance.agent:ProvenanceTransmitter.role.coding
                          Definition

                          A reference to a code defined by a terminology system.

                          ShortCode defined by a terminology system
                          Comments

                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                          Control0..*
                          TypeCoding
                          Is Modifierfalse
                          Must Supporttrue
                          Obligations
                            ObligationsActor
                            SHALL:handlePH Core Server
                            SHALL:handlePH Core Consumer
                            MAY:able-to-populatePH Core Creator
                            Summarytrue
                            Requirements

                            Allows for alternative encodings within a code system, and translations to other code systems.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            68. Provenance.agent:ProvenanceTransmitter.role.text
                            Definition

                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                            ShortPlain text representation of the concept
                            Comments

                            Very often the text is the same as a displayName of one of the codings.

                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Obligations
                              ObligationsActor
                              SHALL:handlePH Core Server
                              SHALL:handlePH Core Consumer
                              MAY:able-to-populatePH Core Creator
                              Summarytrue
                              Requirements

                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              70. Provenance.agent:ProvenanceTransmitter.who
                              Definition

                              The individual, organization, or device that transmitted the information.


                              The individual, device or organization that participated in the event.

                              ShortWho participated
                              Comments

                              References PH Core profiles where available:

                              • PHCorePractitioner | PHCorePractitionerRole | PHCoreOrganization | PHCorePatient | PHCoreRelatedPerson Uses base FHIR Device when no PH Core profile exists.

                              whoIdentity should be used when the agent is not a Resource type.

                              Control1..1
                              TypeReference(PH Core Practitioner, PH Core PractitionerRole, PH Core Organization, PH Core Patient, PH Core RelatedPerson, Device, Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization)
                              Is Modifierfalse
                              Must Supporttrue
                              Must Support TypesNo must-support rules about the choice of types/profiles
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              72. Provenance.agent:ProvenanceTransmitter.onBehalfOf
                              Definition

                              The organization the transmitter is representing. This is mandatory when the transmitter is a Practitioner or Device (per provenance-1 constraint).


                              The individual, device, or organization for whom the change was made.

                              ShortWho the agent is representing
                              Comments

                              References PHCoreOrganization


                              onBehalfOfIdentity should be used when the agent is not a Resource type.

                              Control0..1
                              TypeReference(PH Core Organization, Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization)
                              Is Modifierfalse
                              Must Supporttrue
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

                              Guidance on how to interpret the contents of this table can be foundhere

                              0. Provenance
                              2. Provenance.target
                              Definition

                              The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by a single activity.

                              ShortThe Resource(s) this Provenance record supports
                              Comments

                              See the PH Core Provenance Profile for guidance on supported resource types.

                              Must Supporttrue
                              4. Provenance.target.reference
                              Definition

                              A reference to another resource on the FHIR server.

                              Must Supporttrue
                              6. Provenance.recorded
                              ShortTimestamp when the activity was recorded / updated
                              Comments

                              This is when the activity was recorded, not necessarily when it occurred.

                              Must Supporttrue
                              8. Provenance.location
                              TypeReference(PH Core Location)
                              10. Provenance.reason
                              Must Supporttrue
                              Obligations
                                ObligationsActor
                                SHALL:handlePH Core Server
                                SHALL:handlePH Core Consumer
                                MAY:able-to-populatePH Core Creator
                                12. Provenance.reason.coding
                                Must Supporttrue
                                Obligations
                                  ObligationsActor
                                  SHALL:handlePH Core Server
                                  SHALL:handlePH Core Consumer
                                  MAY:able-to-populatePH Core Creator
                                  14. Provenance.reason.text
                                  Must Supporttrue
                                  Obligations
                                    ObligationsActor
                                    SHALL:handlePH Core Server
                                    SHALL:handlePH Core Consumer
                                    MAY:able-to-populatePH Core Creator
                                    16. Provenance.activity
                                    Must Supporttrue
                                    Obligations
                                      ObligationsActor
                                      SHALL:handlePH Core Server
                                      SHALL:handlePH Core Consumer
                                      MAY:able-to-populatePH Core Creator
                                      18. Provenance.activity.coding
                                      Must Supporttrue
                                      Obligations
                                        ObligationsActor
                                        SHALL:handlePH Core Server
                                        SHALL:handlePH Core Consumer
                                        MAY:able-to-populatePH Core Creator
                                        20. Provenance.activity.text
                                        Must Supporttrue
                                        Obligations
                                          ObligationsActor
                                          SHALL:handlePH Core Server
                                          SHALL:handlePH Core Consumer
                                          MAY:able-to-populatePH Core Creator
                                          22. Provenance.agent
                                          Definition

                                          An actor that takes part in the activity. The actor can be a person, an organization, a device, or a software system.

                                          ShortActor(s) involved
                                          Comments

                                          At least one agent must be provided. Use the ProvenanceAuthor slice for the entity that created the content and ProvenanceTransmitter slice for the entity that sent/transmitted it.

                                          Invariantsprovenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device (who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists())
                                          SlicingThis element introduces a set of slices on Provenance.agent. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ type
                                          • 24. Provenance.agent.type
                                            Definition

                                            The participation the agent had in the activity.

                                            BindingUnless not suitable, these codes SHALL be taken from ProvenanceParticipantType
                                            (extensible to http://hl7.org/fhir/ValueSet/provenance-agent-type)

                                            The type of participation (author, transmitter, etc.)

                                            Must Supporttrue
                                            26. Provenance.agent.role
                                            Must Supporttrue
                                            Obligations
                                              ObligationsActor
                                              SHALL:handlePH Core Server
                                              SHALL:handlePH Core Consumer
                                              MAY:able-to-populatePH Core Creator
                                              28. Provenance.agent.role.coding
                                              Must Supporttrue
                                              Obligations
                                                ObligationsActor
                                                SHALL:handlePH Core Server
                                                SHALL:handlePH Core Consumer
                                                MAY:able-to-populatePH Core Creator
                                                30. Provenance.agent.role.text
                                                Must Supporttrue
                                                Obligations
                                                  ObligationsActor
                                                  SHALL:handlePH Core Server
                                                  SHALL:handlePH Core Consumer
                                                  MAY:able-to-populatePH Core Creator
                                                  32. Provenance.agent.who
                                                  Definition

                                                  The individual, organization, or device that participated in the activity.

                                                  Must Supporttrue
                                                  34. Provenance.agent.onBehalfOf
                                                  Definition

                                                  The organization the agent is representing. This is mandatory when the agent is a Practitioner or Device.

                                                  Comments

                                                  When the agent is a Practitioner or Device, this element identifies the organization they were acting on behalf of.

                                                  Must Supporttrue
                                                  36. Provenance.agent:ProvenanceAuthor
                                                  Slice NameProvenanceAuthor
                                                  Definition

                                                  The entity that created the data. This is typically an organization, practitioner, patient, or device that authored the information.

                                                  ShortAuthor organization or individual responsible for the information
                                                  Comments

                                                  The author is the source of the information being recorded. This slice is used to identify who originally created the content.

                                                  Referenced Profiles:

                                                  • PHCorePractitioner: Philippine healthcare practitioner
                                                  • PHCorePractitionerRole: Practitioner in a specific role
                                                  • PHCoreOrganization: Philippine healthcare organization
                                                  • PHCorePatient: Philippine patient
                                                  • PHCoreRelatedPerson: Related person (family member, guardian, etc.)
                                                  • Device: Base FHIR Device (no PH Core Device profile)
                                                  Control0..*
                                                  Must Supporttrue
                                                  38. Provenance.agent:ProvenanceAuthor.type
                                                  Definition

                                                  The type of agent participation. For the author slice, this is fixed to 'author'.

                                                  Comments

                                                  Fixed value: author

                                                  Control1..?
                                                  Pattern Value{
                                                    "coding" : [{
                                                      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                                                      "code" : "author"
                                                    }]
                                                  }
                                                  40. Provenance.agent:ProvenanceAuthor.role
                                                  Must Supporttrue
                                                  42. Provenance.agent:ProvenanceAuthor.who
                                                  Definition

                                                  The individual, organization, or device that authored the information.

                                                  Comments

                                                  References PH Core profiles where available:

                                                  • PHCorePractitioner | PHCorePractitionerRole | PHCoreOrganization | PHCorePatient | PHCoreRelatedPerson Uses base FHIR Device when no PH Core profile exists.
                                                  TypeReference(PH Core Practitioner, PH Core PractitionerRole, PH Core Organization, PH Core Patient, PH Core RelatedPerson, Device)
                                                  44. Provenance.agent:ProvenanceAuthor.onBehalfOf
                                                  Definition

                                                  The organization the agent is representing. This is mandatory when the agent is a Practitioner or Device (per provenance-1 constraint).

                                                  Comments

                                                  References PHCoreOrganization

                                                  TypeReference(PH Core Organization)
                                                  46. Provenance.agent:ProvenanceTransmitter
                                                  Slice NameProvenanceTransmitter
                                                  Definition

                                                  The entity that transmitted the data from the source to the destination. If the transmitter is a device, the transmitter organization must also be valued.

                                                  ShortTransmitter that provided the information
                                                  Comments

                                                  The transmitter represents who sent the information, which may differ from who authored it. This is important for tracking the chain of custody.

                                                  Referenced Profiles:

                                                  • PHCorePractitioner: Philippine healthcare practitioner
                                                  • PHCorePractitionerRole: Practitioner in a specific role
                                                  • PHCoreOrganization: Philippine healthcare organization
                                                  • PHCorePatient: Philippine patient
                                                  • PHCoreRelatedPerson: Related person (family member, guardian, etc.)
                                                  • Device: Base FHIR Device (no PH Core Device profile)
                                                  Control0..*
                                                  Must Supporttrue
                                                  48. Provenance.agent:ProvenanceTransmitter.type
                                                  Definition

                                                  The type of agent participation. For the transmitter slice, this is fixed to 'transmitter'.

                                                  Comments

                                                  Fixed value: transmitter

                                                  Control1..?
                                                  Pattern Value{
                                                    "coding" : [{
                                                      "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                                                      "code" : "transmitter"
                                                    }]
                                                  }
                                                  50. Provenance.agent:ProvenanceTransmitter.role
                                                  Must Supporttrue
                                                  52. Provenance.agent:ProvenanceTransmitter.who
                                                  Definition

                                                  The individual, organization, or device that transmitted the information.

                                                  Comments

                                                  References PH Core profiles where available:

                                                  • PHCorePractitioner | PHCorePractitionerRole | PHCoreOrganization | PHCorePatient | PHCoreRelatedPerson Uses base FHIR Device when no PH Core profile exists.
                                                  TypeReference(PH Core Practitioner, PH Core PractitionerRole, PH Core Organization, PH Core Patient, PH Core RelatedPerson, Device)
                                                  54. Provenance.agent:ProvenanceTransmitter.onBehalfOf
                                                  Definition

                                                  The organization the transmitter is representing. This is mandatory when the transmitter is a Practitioner or Device (per provenance-1 constraint).

                                                  Comments

                                                  References PHCoreOrganization

                                                  TypeReference(PH Core Organization)

                                                  Guidance on how to interpret the contents of this table can be foundhere

                                                  0. Provenance
                                                  Definition

                                                  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.

                                                  ShortWho, What, When for a set of resources
                                                  Comments

                                                  Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.

                                                  Control0..*
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate NamesHistory, Event, Activity
                                                  Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                                                  dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                                                  dom-6: A resource should have narrative for robust management (text.`div`.exists())
                                                  2. Provenance.id
                                                  Definition

                                                  The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                                                  ShortLogical id of this artifact
                                                  Comments

                                                  The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                                                  Control0..1
                                                  Typeid
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  4. Provenance.meta
                                                  Definition

                                                  The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                                                  ShortMetadata about the resource
                                                  Control0..1
                                                  TypeMeta
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  6. Provenance.implicitRules
                                                  Definition

                                                  A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                                                  ShortA set of rules under which this content was created
                                                  Comments

                                                  Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                                                  Control0..1
                                                  Typeuri
                                                  Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  8. Provenance.language
                                                  Definition

                                                  The base language in which the resource is written.

                                                  ShortLanguage of the resource content
                                                  Comments

                                                  Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                                                  Control0..1
                                                  BindingThe codes SHOULD be taken from CommonLanguages
                                                  (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                                                  A human language.

                                                  Additional BindingsPurpose
                                                  AllLanguagesMax Binding
                                                  Typecode
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  10. Provenance.text
                                                  Definition

                                                  A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                                                  ShortText summary of the resource, for human interpretation
                                                  Comments

                                                  Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                                                  Control0..1
                                                  TypeNarrative
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesnarrative, html, xhtml, display
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  12. Provenance.contained
                                                  Definition

                                                  These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                                                  ShortContained, inline Resources
                                                  Comments

                                                  This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                                                  Control0..*
                                                  TypeResource
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesinline resources, anonymous resources, contained resources
                                                  14. Provenance.extension
                                                  Definition

                                                  May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                  ShortAdditional content defined by implementations
                                                  Comments

                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  16. Provenance.modifierExtension
                                                  Definition

                                                  May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                  ShortExtensions that cannot be ignored
                                                  Comments

                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                                  Summaryfalse
                                                  Requirements

                                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  18. Provenance.target
                                                  Definition

                                                  The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by a single activity.

                                                  ShortThe Resource(s) this Provenance record supports
                                                  Comments

                                                  See the PH Core Provenance Profile for guidance on supported resource types.

                                                  Control1..*
                                                  TypeReference(Resource)
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  20. Provenance.target.id
                                                  Definition

                                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  22. Provenance.target.extension
                                                  Definition

                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                  ShortAdditional content defined by implementations
                                                  Comments

                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  SlicingThis element introduces a set of slices on Provenance.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 24. Provenance.target.reference
                                                    Definition

                                                    A reference to another resource on the FHIR server.

                                                    ShortLiteral reference, Relative, internal or absolute URL
                                                    Comments

                                                    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                    Control0..1
                                                    This element is affected by the following invariants: ref-1
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    26. Provenance.target.type
                                                    Definition

                                                    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                    ShortType the reference refers to (e.g. "Patient")
                                                    Comments

                                                    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                    Control0..1
                                                    BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                    (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                    Aa resource (or, for logical models, the URI of the logical model).

                                                    Typeuri
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    28. Provenance.target.identifier
                                                    Definition

                                                    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                    ShortLogical reference, when literal reference is not known
                                                    Comments

                                                    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                                    Control0..1
                                                    TypeIdentifier
                                                    Is Modifierfalse
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    30. Provenance.target.display
                                                    Definition

                                                    Plain text narrative that identifies the resource in addition to the resource reference.

                                                    ShortText alternative for the resource
                                                    Comments

                                                    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                    Control0..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    32. Provenance.occurred[x]
                                                    Definition

                                                    The period during which the activity occurred.

                                                    ShortWhen the activity occurred
                                                    Comments

                                                    The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.

                                                    Control0..1
                                                    TypeChoice of: Period, dateTime
                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    34. Provenance.recorded
                                                    Definition

                                                    The instant of time at which the activity was recorded.

                                                    ShortTimestamp when the activity was recorded / updated
                                                    Comments

                                                    This is when the activity was recorded, not necessarily when it occurred.

                                                    Control1..1
                                                    Typeinstant
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    36. Provenance.policy
                                                    Definition

                                                    Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.

                                                    ShortPolicy or plan the activity was defined by
                                                    Comments

                                                    For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.

                                                    Control0..*
                                                    Typeuri
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    38. Provenance.location
                                                    Definition

                                                    Where the activity occurred, if relevant.

                                                    ShortWhere the activity occurred, if relevant
                                                    Control0..1
                                                    TypeReference(PH Core Location)
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    40. Provenance.reason
                                                    Definition

                                                    The reason that the activity was taking place.

                                                    ShortReason the activity is occurring
                                                    Control0..*
                                                    BindingUnless not suitable, these codes SHALL be taken from PurposeOfUse
                                                    (extensible to http://terminology.hl7.org/ValueSet/v3-PurposeOfUse)

                                                    The reason the activity took place.

                                                    TypeCodeableConcept
                                                    Is Modifierfalse
                                                    Must Supporttrue
                                                    Obligations
                                                      ObligationsActor
                                                      SHALL:handlePH Core Server
                                                      SHALL:handlePH Core Consumer
                                                      MAY:able-to-populatePH Core Creator
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      42. Provenance.reason.id
                                                      Definition

                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                      ShortUnique id for inter-element referencing
                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      44. Provenance.reason.extension
                                                      Definition

                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                      ShortAdditional content defined by implementations
                                                      Comments

                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                      Control0..*
                                                      TypeExtension
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Alternate Namesextensions, user content
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      SlicingThis element introduces a set of slices on Provenance.reason.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 46. Provenance.reason.coding
                                                        Definition

                                                        A reference to a code defined by a terminology system.

                                                        ShortCode defined by a terminology system
                                                        Comments

                                                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                        Control0..*
                                                        TypeCoding
                                                        Is Modifierfalse
                                                        Must Supporttrue
                                                        Obligations
                                                          ObligationsActor
                                                          SHALL:handlePH Core Server
                                                          SHALL:handlePH Core Consumer
                                                          MAY:able-to-populatePH Core Creator
                                                          Summarytrue
                                                          Requirements

                                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          48. Provenance.reason.text
                                                          Definition

                                                          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                          ShortPlain text representation of the concept
                                                          Comments

                                                          Very often the text is the same as a displayName of one of the codings.

                                                          Control0..1
                                                          Typestring
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supporttrue
                                                          Obligations
                                                            ObligationsActor
                                                            SHALL:handlePH Core Server
                                                            SHALL:handlePH Core Consumer
                                                            MAY:able-to-populatePH Core Creator
                                                            Summarytrue
                                                            Requirements

                                                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            50. Provenance.activity
                                                            Definition

                                                            An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.

                                                            ShortActivity that occurred
                                                            Control0..1
                                                            BindingUnless not suitable, these codes SHALL be taken from ProvenanceActivityType
                                                            (extensible to http://hl7.org/fhir/ValueSet/provenance-activity-type|4.0.1)

                                                            The activity that took place.

                                                            TypeCodeableConcept
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            Obligations
                                                              ObligationsActor
                                                              SHALL:handlePH Core Server
                                                              SHALL:handlePH Core Consumer
                                                              MAY:able-to-populatePH Core Creator
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              52. Provenance.activity.id
                                                              Definition

                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                              ShortUnique id for inter-element referencing
                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              54. Provenance.activity.extension
                                                              Definition

                                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                              ShortAdditional content defined by implementations
                                                              Comments

                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                              Control0..*
                                                              TypeExtension
                                                              Is Modifierfalse
                                                              Summaryfalse
                                                              Alternate Namesextensions, user content
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                              SlicingThis element introduces a set of slices on Provenance.activity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 56. Provenance.activity.coding
                                                                Definition

                                                                A reference to a code defined by a terminology system.

                                                                ShortCode defined by a terminology system
                                                                Comments

                                                                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                Control0..*
                                                                TypeCoding
                                                                Is Modifierfalse
                                                                Must Supporttrue
                                                                Obligations
                                                                  ObligationsActor
                                                                  SHALL:handlePH Core Server
                                                                  SHALL:handlePH Core Consumer
                                                                  MAY:able-to-populatePH Core Creator
                                                                  Summarytrue
                                                                  Requirements

                                                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  58. Provenance.activity.text
                                                                  Definition

                                                                  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                  ShortPlain text representation of the concept
                                                                  Comments

                                                                  Very often the text is the same as a displayName of one of the codings.

                                                                  Control0..1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Must Supporttrue
                                                                  Obligations
                                                                    ObligationsActor
                                                                    SHALL:handlePH Core Server
                                                                    SHALL:handlePH Core Consumer
                                                                    MAY:able-to-populatePH Core Creator
                                                                    Summarytrue
                                                                    Requirements

                                                                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    60. Provenance.agent
                                                                    Definition

                                                                    An actor that takes part in the activity. The actor can be a person, an organization, a device, or a software system.

                                                                    ShortActor(s) involved
                                                                    Comments

                                                                    At least one agent must be provided. Use the ProvenanceAuthor slice for the entity that created the content and ProvenanceTransmitter slice for the entity that sent/transmitted it.

                                                                    Control1..*
                                                                    TypeBackboneElement
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Requirements

                                                                    An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device (who.exists((resolve() is Practitioner) or (resolve() is Device)) implies onBehalfOf.exists())
                                                                    SlicingThis element introduces a set of slices on Provenance.agent. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                    • value @ type
                                                                    • 62. Provenance.agent.id
                                                                      Definition

                                                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                      ShortUnique id for inter-element referencing
                                                                      Control0..1
                                                                      Typestring
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      64. Provenance.agent.extension
                                                                      Definition

                                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                      ShortAdditional content defined by implementations
                                                                      Comments

                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                      Control0..*
                                                                      TypeExtension
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Alternate Namesextensions, user content
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      66. Provenance.agent.modifierExtension
                                                                      Definition

                                                                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                      Comments

                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                      Control0..*
                                                                      TypeExtension
                                                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                      Summarytrue
                                                                      Requirements

                                                                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                      Alternate Namesextensions, user content, modifiers
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      68. Provenance.agent.type
                                                                      Definition

                                                                      The participation the agent had in the activity.

                                                                      ShortHow the agent participated
                                                                      Comments

                                                                      For example: author, performer, enterer, attester, etc.

                                                                      Control0..1
                                                                      BindingUnless not suitable, these codes SHALL be taken from ProvenanceParticipantType
                                                                      (extensible to http://hl7.org/fhir/ValueSet/provenance-agent-type)

                                                                      The type of participation (author, transmitter, etc.)

                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Must Supporttrue
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      70. Provenance.agent.role
                                                                      Definition

                                                                      The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

                                                                      ShortWhat the agents role was
                                                                      Comments

                                                                      For example: doctor, nurse, clerk, etc.

                                                                      Control0..*
                                                                      BindingFor example codes, see SecurityRoleType
                                                                      (example to http://hl7.org/fhir/ValueSet/security-role-type|4.0.1)

                                                                      The role that a provenance agent played with respect to the activity.

                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Must Supporttrue
                                                                      Obligations
                                                                        ObligationsActor
                                                                        SHALL:handlePH Core Server
                                                                        SHALL:handlePH Core Consumer
                                                                        MAY:able-to-populatePH Core Creator
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        72. Provenance.agent.role.id
                                                                        Definition

                                                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                        ShortUnique id for inter-element referencing
                                                                        Control0..1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                        Summaryfalse
                                                                        74. Provenance.agent.role.extension
                                                                        Definition

                                                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                        ShortAdditional content defined by implementations
                                                                        Comments

                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                        Control0..*
                                                                        TypeExtension
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Alternate Namesextensions, user content
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        SlicingThis element introduces a set of slices on Provenance.agent.role.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 76. Provenance.agent.role.coding
                                                                          Definition

                                                                          A reference to a code defined by a terminology system.

                                                                          ShortCode defined by a terminology system
                                                                          Comments

                                                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                          Control0..*
                                                                          TypeCoding
                                                                          Is Modifierfalse
                                                                          Must Supporttrue
                                                                          Obligations
                                                                            ObligationsActor
                                                                            SHALL:handlePH Core Server
                                                                            SHALL:handlePH Core Consumer
                                                                            MAY:able-to-populatePH Core Creator
                                                                            Summarytrue
                                                                            Requirements

                                                                            Allows for alternative encodings within a code system, and translations to other code systems.

                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            78. Provenance.agent.role.text
                                                                            Definition

                                                                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                            ShortPlain text representation of the concept
                                                                            Comments

                                                                            Very often the text is the same as a displayName of one of the codings.

                                                                            Control0..1
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Must Supporttrue
                                                                            Obligations
                                                                              ObligationsActor
                                                                              SHALL:handlePH Core Server
                                                                              SHALL:handlePH Core Consumer
                                                                              MAY:able-to-populatePH Core Creator
                                                                              Summarytrue
                                                                              Requirements

                                                                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              80. Provenance.agent.who
                                                                              Definition

                                                                              The individual, organization, or device that participated in the activity.

                                                                              ShortWho participated
                                                                              Comments

                                                                              whoIdentity should be used when the agent is not a Resource type.

                                                                              Control1..1
                                                                              TypeReference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization)
                                                                              Is Modifierfalse
                                                                              Must Supporttrue
                                                                              Must Support TypesNo must-support rules about the choice of types/profiles
                                                                              Summarytrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              82. Provenance.agent.onBehalfOf
                                                                              Definition

                                                                              The organization the agent is representing. This is mandatory when the agent is a Practitioner or Device.

                                                                              ShortWho the agent is representing
                                                                              Comments

                                                                              When the agent is a Practitioner or Device, this element identifies the organization they were acting on behalf of.

                                                                              Control0..1
                                                                              TypeReference(Practitioner, PractitionerRole, RelatedPerson, Patient, Device, Organization)
                                                                              Is Modifierfalse
                                                                              Must Supporttrue
                                                                              Must Support TypesNo must-support rules about the choice of types/profiles
                                                                              Summaryfalse
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              84. Provenance.agent:ProvenanceAuthor
                                                                              Slice NameProvenanceAuthor
                                                                              Definition

                                                                              The entity that created the data. This is typically an organization, practitioner, patient, or device that authored the information.

                                                                              ShortAuthor organization or individual responsible for the information
                                                                              Comments

                                                                              The author is the source of the information being recorded. This slice is used to identify who originally created the content.

                                                                              Referenced Profiles:

                                                                              • PHCorePractitioner: Philippine healthcare practitioner
                                                                              • PHCorePractitionerRole: Practitioner in a specific role
                                                                              • PHCoreOrganization: Philippine healthcare organization
                                                                              • PHCorePatient: Philippine patient
                                                                              • PHCoreRelatedPerson: Related person (family member, guardian, etc.)
                                                                              • Device: Base FHIR Device (no PH Core Device profile)
                                                                              Control0..*
                                                                              TypeBackboneElement
                                                                              Is Modifierfalse
                                                                              Must Supporttrue
                                                                              Summaryfalse
                                                                              Requirements

                                                                              An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              86. Provenance.agent:ProvenanceAuthor.id
                                                                              Definition

                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                              ShortUnique id for inter-element referencing
                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              88. Provenance.agent:ProvenanceAuthor.extension
                                                                              Definition

                                                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                              ShortAdditional content defined by implementations
                                                                              Comments

                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                              Control0..*
                                                                              TypeExtension
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Alternate Namesextensions, user content
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              90. Provenance.agent:ProvenanceAuthor.modifierExtension
                                                                              Definition

                                                                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                              ShortExtensions that cannot be ignored even if unrecognized
                                                                              Comments

                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                              Control0..*
                                                                              TypeExtension
                                                                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                              Summarytrue
                                                                              Requirements

                                                                              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                              Alternate Namesextensions, user content, modifiers
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              92. Provenance.agent:ProvenanceAuthor.type
                                                                              Definition

                                                                              The type of agent participation. For the author slice, this is fixed to 'author'.

                                                                              ShortHow the agent participated
                                                                              Comments

                                                                              Fixed value: author

                                                                              Control1..1
                                                                              BindingUnless not suitable, these codes SHALL be taken from ProvenanceParticipantType
                                                                              (extensible to http://hl7.org/fhir/ValueSet/provenance-agent-type)

                                                                              The type of participation (author, transmitter, etc.)

                                                                              TypeCodeableConcept
                                                                              Is Modifierfalse
                                                                              Must Supporttrue
                                                                              Summarytrue
                                                                              Pattern Value{
                                                                                "coding" : [{
                                                                                  "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                                                                                  "code" : "author"
                                                                                }]
                                                                              }
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              94. Provenance.agent:ProvenanceAuthor.role
                                                                              Definition

                                                                              The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

                                                                              ShortWhat the agents role was
                                                                              Comments

                                                                              For example: doctor, nurse, clerk, etc.

                                                                              Control0..*
                                                                              BindingFor example codes, see SecurityRoleType
                                                                              (example to http://hl7.org/fhir/ValueSet/security-role-type|4.0.1)

                                                                              The role that a provenance agent played with respect to the activity.

                                                                              TypeCodeableConcept
                                                                              Is Modifierfalse
                                                                              Must Supporttrue
                                                                              Summaryfalse
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              96. Provenance.agent:ProvenanceAuthor.role.id
                                                                              Definition

                                                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                              ShortUnique id for inter-element referencing
                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              98. Provenance.agent:ProvenanceAuthor.role.extension
                                                                              Definition

                                                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                              ShortAdditional content defined by implementations
                                                                              Comments

                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                              Control0..*
                                                                              TypeExtension
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Alternate Namesextensions, user content
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              SlicingThis element introduces a set of slices on Provenance.agent.role.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                              • value @ url
                                                                              • 100. Provenance.agent:ProvenanceAuthor.role.coding
                                                                                Definition

                                                                                A reference to a code defined by a terminology system.

                                                                                ShortCode defined by a terminology system
                                                                                Comments

                                                                                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                Control0..*
                                                                                TypeCoding
                                                                                Is Modifierfalse
                                                                                Must Supporttrue
                                                                                Obligations
                                                                                  ObligationsActor
                                                                                  SHALL:handlePH Core Server
                                                                                  SHALL:handlePH Core Consumer
                                                                                  MAY:able-to-populatePH Core Creator
                                                                                  Summarytrue
                                                                                  Requirements

                                                                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  102. Provenance.agent:ProvenanceAuthor.role.text
                                                                                  Definition

                                                                                  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                  ShortPlain text representation of the concept
                                                                                  Comments

                                                                                  Very often the text is the same as a displayName of one of the codings.

                                                                                  Control0..1
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Must Supporttrue
                                                                                  Obligations
                                                                                    ObligationsActor
                                                                                    SHALL:handlePH Core Server
                                                                                    SHALL:handlePH Core Consumer
                                                                                    MAY:able-to-populatePH Core Creator
                                                                                    Summarytrue
                                                                                    Requirements

                                                                                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    104. Provenance.agent:ProvenanceAuthor.who
                                                                                    Definition

                                                                                    The individual, organization, or device that authored the information.

                                                                                    ShortWho participated
                                                                                    Comments

                                                                                    References PH Core profiles where available:

                                                                                    • PHCorePractitioner | PHCorePractitionerRole | PHCoreOrganization | PHCorePatient | PHCoreRelatedPerson Uses base FHIR Device when no PH Core profile exists.
                                                                                    Control1..1
                                                                                    TypeReference(PH Core Practitioner, PH Core PractitionerRole, PH Core Organization, PH Core Patient, PH Core RelatedPerson, Device)
                                                                                    Is Modifierfalse
                                                                                    Must Supporttrue
                                                                                    Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    106. Provenance.agent:ProvenanceAuthor.onBehalfOf
                                                                                    Definition

                                                                                    The organization the agent is representing. This is mandatory when the agent is a Practitioner or Device (per provenance-1 constraint).

                                                                                    ShortWho the agent is representing
                                                                                    Comments

                                                                                    References PHCoreOrganization

                                                                                    Control0..1
                                                                                    TypeReference(PH Core Organization)
                                                                                    Is Modifierfalse
                                                                                    Must Supporttrue
                                                                                    Summaryfalse
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    108. Provenance.agent:ProvenanceTransmitter
                                                                                    Slice NameProvenanceTransmitter
                                                                                    Definition

                                                                                    The entity that transmitted the data from the source to the destination. If the transmitter is a device, the transmitter organization must also be valued.

                                                                                    ShortTransmitter that provided the information
                                                                                    Comments

                                                                                    The transmitter represents who sent the information, which may differ from who authored it. This is important for tracking the chain of custody.

                                                                                    Referenced Profiles:

                                                                                    • PHCorePractitioner: Philippine healthcare practitioner
                                                                                    • PHCorePractitionerRole: Practitioner in a specific role
                                                                                    • PHCoreOrganization: Philippine healthcare organization
                                                                                    • PHCorePatient: Philippine patient
                                                                                    • PHCoreRelatedPerson: Related person (family member, guardian, etc.)
                                                                                    • Device: Base FHIR Device (no PH Core Device profile)
                                                                                    Control0..*
                                                                                    TypeBackboneElement
                                                                                    Is Modifierfalse
                                                                                    Must Supporttrue
                                                                                    Summaryfalse
                                                                                    Requirements

                                                                                    An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.

                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    110. Provenance.agent:ProvenanceTransmitter.id
                                                                                    Definition

                                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                    ShortUnique id for inter-element referencing
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    112. Provenance.agent:ProvenanceTransmitter.extension
                                                                                    Definition

                                                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                    ShortAdditional content defined by implementations
                                                                                    Comments

                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                    Control0..*
                                                                                    TypeExtension
                                                                                    Is Modifierfalse
                                                                                    Summaryfalse
                                                                                    Alternate Namesextensions, user content
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                    114. Provenance.agent:ProvenanceTransmitter.modifierExtension
                                                                                    Definition

                                                                                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                                    ShortExtensions that cannot be ignored even if unrecognized
                                                                                    Comments

                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                    Control0..*
                                                                                    TypeExtension
                                                                                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                    Summarytrue
                                                                                    Requirements

                                                                                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                                    Alternate Namesextensions, user content, modifiers
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                    116. Provenance.agent:ProvenanceTransmitter.type
                                                                                    Definition

                                                                                    The type of agent participation. For the transmitter slice, this is fixed to 'transmitter'.

                                                                                    ShortHow the agent participated
                                                                                    Comments

                                                                                    Fixed value: transmitter

                                                                                    Control1..1
                                                                                    BindingUnless not suitable, these codes SHALL be taken from ProvenanceParticipantType
                                                                                    (extensible to http://hl7.org/fhir/ValueSet/provenance-agent-type)

                                                                                    The type of participation (author, transmitter, etc.)

                                                                                    TypeCodeableConcept
                                                                                    Is Modifierfalse
                                                                                    Must Supporttrue
                                                                                    Summarytrue
                                                                                    Pattern Value{
                                                                                      "coding" : [{
                                                                                        "system" : "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                                                                                        "code" : "transmitter"
                                                                                      }]
                                                                                    }
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    118. Provenance.agent:ProvenanceTransmitter.role
                                                                                    Definition

                                                                                    The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

                                                                                    ShortWhat the agents role was
                                                                                    Comments

                                                                                    For example: doctor, nurse, clerk, etc.

                                                                                    Control0..*
                                                                                    BindingFor example codes, see SecurityRoleType
                                                                                    (example to http://hl7.org/fhir/ValueSet/security-role-type|4.0.1)

                                                                                    The role that a provenance agent played with respect to the activity.

                                                                                    TypeCodeableConcept
                                                                                    Is Modifierfalse
                                                                                    Must Supporttrue
                                                                                    Summaryfalse
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    120. Provenance.agent:ProvenanceTransmitter.role.id
                                                                                    Definition

                                                                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                    ShortUnique id for inter-element referencing
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    122. Provenance.agent:ProvenanceTransmitter.role.extension
                                                                                    Definition

                                                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                    ShortAdditional content defined by implementations
                                                                                    Comments

                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                    Control0..*
                                                                                    TypeExtension
                                                                                    Is Modifierfalse
                                                                                    Summaryfalse
                                                                                    Alternate Namesextensions, user content
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                    SlicingThis element introduces a set of slices on Provenance.agent.role.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                    • value @ url
                                                                                    • 124. Provenance.agent:ProvenanceTransmitter.role.coding
                                                                                      Definition

                                                                                      A reference to a code defined by a terminology system.

                                                                                      ShortCode defined by a terminology system
                                                                                      Comments

                                                                                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                      Control0..*
                                                                                      TypeCoding
                                                                                      Is Modifierfalse
                                                                                      Must Supporttrue
                                                                                      Obligations
                                                                                        ObligationsActor
                                                                                        SHALL:handlePH Core Server
                                                                                        SHALL:handlePH Core Consumer
                                                                                        MAY:able-to-populatePH Core Creator
                                                                                        Summarytrue
                                                                                        Requirements

                                                                                        Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        126. Provenance.agent:ProvenanceTransmitter.role.text
                                                                                        Definition

                                                                                        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                        ShortPlain text representation of the concept
                                                                                        Comments

                                                                                        Very often the text is the same as a displayName of one of the codings.

                                                                                        Control0..1
                                                                                        Typestring
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Must Supporttrue
                                                                                        Obligations
                                                                                          ObligationsActor
                                                                                          SHALL:handlePH Core Server
                                                                                          SHALL:handlePH Core Consumer
                                                                                          MAY:able-to-populatePH Core Creator
                                                                                          Summarytrue
                                                                                          Requirements

                                                                                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          128. Provenance.agent:ProvenanceTransmitter.who
                                                                                          Definition

                                                                                          The individual, organization, or device that transmitted the information.

                                                                                          ShortWho participated
                                                                                          Comments

                                                                                          References PH Core profiles where available:

                                                                                          • PHCorePractitioner | PHCorePractitionerRole | PHCoreOrganization | PHCorePatient | PHCoreRelatedPerson Uses base FHIR Device when no PH Core profile exists.
                                                                                          Control1..1
                                                                                          TypeReference(PH Core Practitioner, PH Core PractitionerRole, PH Core Organization, PH Core Patient, PH Core RelatedPerson, Device)
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          130. Provenance.agent:ProvenanceTransmitter.onBehalfOf
                                                                                          Definition

                                                                                          The organization the transmitter is representing. This is mandatory when the transmitter is a Practitioner or Device (per provenance-1 constraint).

                                                                                          ShortWho the agent is representing
                                                                                          Comments

                                                                                          References PHCoreOrganization

                                                                                          Control0..1
                                                                                          TypeReference(PH Core Organization)
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          132. Provenance.entity
                                                                                          Definition

                                                                                          An entity used in this activity.

                                                                                          ShortAn entity used in this activity
                                                                                          Control0..*
                                                                                          TypeBackboneElement
                                                                                          Is Modifierfalse
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          134. Provenance.entity.id
                                                                                          Definition

                                                                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                                                          ShortUnique id for inter-element referencing
                                                                                          Control0..1
                                                                                          Typestring
                                                                                          Is Modifierfalse
                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                          Summaryfalse
                                                                                          136. Provenance.entity.extension
                                                                                          Definition

                                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                          ShortAdditional content defined by implementations
                                                                                          Comments

                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                          Control0..*
                                                                                          TypeExtension
                                                                                          Is Modifierfalse
                                                                                          Summaryfalse
                                                                                          Alternate Namesextensions, user content
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          138. Provenance.entity.modifierExtension
                                                                                          Definition

                                                                                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                          Comments

                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                          Control0..*
                                                                                          TypeExtension
                                                                                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                          Summarytrue
                                                                                          Requirements

                                                                                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                                          Alternate Namesextensions, user content, modifiers
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          140. Provenance.entity.role
                                                                                          Definition

                                                                                          How the entity was used during the activity.

                                                                                          Shortderivation | revision | quotation | source | removal
                                                                                          Control1..1
                                                                                          BindingThe codes SHALL be taken from ProvenanceEntityRole
                                                                                          (required to http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1)

                                                                                          How an entity was used in an activity.

                                                                                          Typecode
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          142. Provenance.entity.what
                                                                                          Definition

                                                                                          Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.

                                                                                          ShortIdentity of entity
                                                                                          Comments

                                                                                          whatIdentity should be used for entities that are not a Resource type.

                                                                                          Control1..1
                                                                                          TypeReference(Resource)
                                                                                          Is Modifierfalse
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          144. Provenance.entity.agent
                                                                                          Definition

                                                                                          The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.

                                                                                          ShortEntity is attributed to this agent
                                                                                          Comments

                                                                                          A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 v2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity.

                                                                                          Control0..*
                                                                                          TypeSeettp://hl7.org/fhir/StructureDefinition/Provenance#Provenance.agent
                                                                                          Is Modifierfalse
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          146. Provenance.signature
                                                                                          Definition

                                                                                          A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.

                                                                                          ShortSignature on target
                                                                                          Control0..*
                                                                                          TypeSignature
                                                                                          Is Modifierfalse
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))