Data Model Libraries
    Preparing search index...

    ProvenanceEntityComponent Class

    FHIR Specification

    • Short: An entity used in this activity
    • Definition: An entity used in this activity.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    provenanceEntityRoleEnum: ProvenanceEntityRoleEnum

    FHIR CodeSystem: ProvenanceEntityRole

    role: null | EnumCodeType

    Provenance.entity.role Element

    FHIR Specification

    • Short: derivation | revision | quotation | source | removal
    • Definition: How the entity was used during the activity.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ProvenanceEntityRoleEnum

    what: null | Reference

    Provenance.entity.what Element

    FHIR Specification

    • Short: Identity of entity
    • Definition: Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
    • Comment: whatIdentity should be used for entities that are not a Resource type.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Provenance.entity.agent Element

    FHIR Specification

    • Short: Entity is attributed to this 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.
    • Comment: 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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided ProvenanceEntityComponent JSON to instantiate the ProvenanceEntityComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ProvenanceEntityComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ProvenanceEntityComponent

      Returns undefined | ProvenanceEntityComponent

      ProvenanceEntityComponent data model or undefined for ProvenanceEntityComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise