Data Model Libraries
    Preparing search index...

    Class ProvenanceAgentComponent

    ProvenanceAgentComponent Class

    FHIR Specification

    • Short: Actor involved
    • Definition: An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
    • Comment: Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.
    • Requirements: An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.

    FHIR Provenance

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    type_? role? who onBehalfOf?

    Methods

    parse getType setType hasType getRole setRole addRole hasRole getWho setWho hasWho getOnBehalfOf setOnBehalfOf hasOnBehalfOf fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initRole

    Constructors

    Properties

    Private Optionaltype_

    type_?: CodeableConcept

    Provenance.agent.type Element

    FHIR Specification

    • Short: How the agent participated
    • Definition: The Functional Role of the agent with respect to the activity.
    • Comment: For example: assembler, author, prescriber, signer, investigator, etc.
    • Requirements: Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    role?: CodeableConcept[]

    Provenance.agent.role Element

    FHIR Specification

    • Short: What the agents role was
    • Definition: The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.
    • Comment: For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.
    • Requirements: Structural roles reflect the structural aspects of relationships between entities. Structural roles describe prerequisites, feasibilities, or competences for acts. Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models..
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    who: null | Reference

    Provenance.agent.who Element

    FHIR Specification

    onBehalfOf?: Reference

    Provenance.agent.onBehalfOf Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ProvenanceAgentComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ProvenanceAgentComponent

      ProvenanceAgentComponent data model or undefined for ProvenanceAgentComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Who object value to the who property.

      Parameters

      • value: undefined | null | Reference

        the who object value

      Returns this

      this

      @ReferenceTargets('Provenance.agent.who', ['Practitioner','PractitionerRole','Organization','CareTeam','Patient','Device','RelatedPerson',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided OnBehalfOf object value to the onBehalfOf property.

      Parameters

      • value: undefined | Reference

        the onBehalfOf object value

      Returns this

      this

      @ReferenceTargets('Provenance.agent.onBehalfOf', ['Practitioner','PractitionerRole','Organization','CareTeam','Patient',])

      InvalidTypeError for invalid data type or reference value

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods