---
type: "resource-definitions"
title: "ActorDefinition Definitions"
resource: "ActorDefinition"
---

# ActorDefinition Definitions

<a id="ActorDefinition"></a>

## ActorDefinition
A system or non-system participant involved in an information exchange process

**Definition:** Provides a definition of an actor - a system, individual, non-system device, or collective - that plays a role in a process, such as data exchange, along with associated obligations.

**Cardinality:** 0..*

**Constraints:** cnl-0 | warning | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')

**Mappings:** w5=conformance.content


<a id="ActorDefinition.url"></a>

## ActorDefinition.url
Canonical identifier for this actor definition, represented as a URI (globally unique)

**Definition:** An absolute URI that is used to identify this actor definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this actor definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the actor definition is stored on different servers.

**Comments:** Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred.  Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author.  Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). 

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.

**Requirements:** Allows the actor definition to be referenced by a single globally unique identifier.

**Cardinality:** 0..1

**Type:** [uri](/uri)

**Summary:** true

**Constraints:** cnl-1 | warning | URL should not contain | or # - these characters make processing canonical references problematic | exists() implies matches('^[^|# ]+$')

**Mappings:** w5=FiveWs.identifier


<a id="ActorDefinition.identifier"></a>

## ActorDefinition.identifier
Additional identifier for the actor definition (business identifier)

**Definition:** A formal identifier that is used to identify this actor definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

**Requirements:** Allows externally provided and/or usable business identifiers to be easily associated with the module.

**Cardinality:** 0..*

**Type:** [Identifier](/Identifier)

**Summary:** true

**Mappings:** w5=FiveWs.identifier


<a id="ActorDefinition.version"></a>

## ActorDefinition.version
Business version of the actor definition

**Definition:** The identifier that is used to identify this version of the actor definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the actor definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

**Comments:** There may be different actor definition instances that have the same identifier but different versions.  The version can be appended to the url in a reference to allow a reference to a particular business version of the actor definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).

**Cardinality:** 0..1

**Type:** [string](/string)

**Summary:** true

**Mappings:** w5=FiveWs.version


<a id="ActorDefinition.versionAlgorithm[x]"></a>

## ActorDefinition.versionAlgorithm[x]
How to compare versions

**Definition:** Indicates the mechanism used to compare versions to determine which is more current.

**Comments:** If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

**Cardinality:** 0..1

**Type:** [string](/string), [Coding](/Coding)

**Binding:** extensible:[version-algorithm](/valueset-version-algorithm)

**Summary:** true


<a id="ActorDefinition.name"></a>

## ActorDefinition.name
Name for this actor definition (computer friendly)

**Definition:** A natural language name identifying the actor definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

**Comments:** The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

**Requirements:** Support human navigation and code generation.

**Conditions:** cnl-0

**Cardinality:** 0..1

**Type:** [string](/string)

**Summary:** true


<a id="ActorDefinition.title"></a>

## ActorDefinition.title
Name for this actor definition (human friendly)

**Definition:** A short, descriptive, user-friendly title for the actor definition.

**Comments:** This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

**Cardinality:** 0..1

**Type:** [string](/string)

**Summary:** true


<a id="ActorDefinition.status"></a>

## ActorDefinition.status
draft | active | retired | unknown

**Definition:** The status of this actor definition. Enables tracking the life-cycle of the content.

**Comments:** Allows filtering of actor definitions that are appropriate for use versus not.

See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).

**Cardinality:** 1..1

**Type:** [code](/code)

**Binding:** required:[publication-status](/valueset-publication-status)

**Summary:** true

**Is Modifier:** true (Reason: This is labeled as "Is Modifier" because designs and applications should not use a retired ActorDefinition without due consideration)

**Mappings:** w5=FiveWs.status


<a id="ActorDefinition.experimental"></a>

## ActorDefinition.experimental
For testing only - never for real usage

**Definition:** A Boolean value to indicate that this actor definition is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.

**Comments:** Allows filtering of actor definitions that are appropriate for use versus not.. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource.  (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

**Requirements:** Enables experimental content to be developed following the same lifecycle that would be used for a production-level actor definition.

**Meaning if Missing:** If absent, this resource is treated as though it is not experimental.

**Cardinality:** 0..1

**Type:** [boolean](/boolean)

**Summary:** true

**Mappings:** w5=FiveWs.class


<a id="ActorDefinition.date"></a>

## ActorDefinition.date
Date last changed

**Definition:** The date  (and optionally time) when the actor definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the actor definition changes.

**Comments:** The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the actor definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).

**Aliases:** Revision Date

**Cardinality:** 0..1

**Type:** [dateTime](/dateTime)

**Summary:** true

**Mappings:** w5=FiveWs.recorded


<a id="ActorDefinition.publisher"></a>

## ActorDefinition.publisher
Name of the publisher/steward (organization or individual)

**Definition:** The name of the organization or individual responsible for the release and ongoing maintenance of the actor definition.

**Comments:** Usually an organization but may be an individual. The publisher (or steward) of the actor definition is the organization or individual primarily responsible for the maintenance and upkeep of the actor definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the actor definition. This item SHOULD be populated unless the information is available from context.

**Requirements:** Helps establish the "authority/credibility" of the actor definition.  May also allow for contact.

**Cardinality:** 0..1

**Type:** [string](/string)

**Summary:** true

**Mappings:** w5=FiveWs.witness


<a id="ActorDefinition.contact"></a>

## ActorDefinition.contact
Contact details for the publisher

**Definition:** Contact details to assist a user in finding and communicating with the publisher.

**Comments:** May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).

**Cardinality:** 0..*

**Type:** [ContactDetail](/ContactDetail)

**Summary:** true


<a id="ActorDefinition.description"></a>

## ActorDefinition.description
Natural language description of the actor

**Definition:** A free text natural language description of the actor.

**Comments:** This description can be used for a general description of the actor, and which covers why it was defined.

**Aliases:** Scope, Purpose

**Cardinality:** 0..1

**Type:** [markdown](/markdown)


<a id="ActorDefinition.useContext"></a>

## ActorDefinition.useContext
The context that the content is intended to support

**Definition:** The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate actor definition instances.

**Comments:** When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

**Requirements:** Assist in searching for appropriate content.

**Cardinality:** 0..*

**Type:** [UsageContext](/UsageContext)

**Summary:** true


<a id="ActorDefinition.jurisdiction"></a>

## ActorDefinition.jurisdiction
Jurisdiction of the authority that maintains the actor definition (if applicable)

**Definition:** A legal or geographic region in which the authority that maintains the resource is operating.  In general, the jurisdiction is also found in the useContext.  The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.

**Comments:** It may be possible for the actor definition to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element.  (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

**Cardinality:** 0..*

**Type:** [CodeableConcept](/CodeableConcept)

**Binding:** extensible:[jurisdiction](/valueset-jurisdiction)

**Summary:** true


<a id="ActorDefinition.purpose"></a>

## ActorDefinition.purpose
Why this actor definition is defined

**Definition:** Explanation of why this actor definition is needed and why it has been designed as it has.

**Comments:** This element does not describe the usage of the actor definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is.  This may be used to point to source materials or specifications that drove the structure of this actor definition.

**Cardinality:** 0..1

**Type:** [markdown](/markdown)

**Mappings:** w5=FiveWs.why[x]


<a id="ActorDefinition.copyright"></a>

## ActorDefinition.copyright
Notice about intellectual property ownership, can include restrictions on use

**Definition:** A copyright statement relating to the actor definition and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the actor definition.

**Comments:** ...

**Requirements:** Consumers must be able to determine any legal restrictions on the use of the actor definition.

**Aliases:** License, Restrictions

**Cardinality:** 0..1

**Type:** [markdown](/markdown)


<a id="ActorDefinition.copyrightLabel"></a>

## ActorDefinition.copyrightLabel
Copyright holder and year(s)

**Definition:** A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').

**Comments:** The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

**Requirements:** Defines the content expected to be rendered in all representations of the artifact.

**Cardinality:** 0..1

**Type:** [string](/string)


<a id="ActorDefinition.type"></a>

## ActorDefinition.type
person | system | collective | other

**Definition:** What type of actor this is.

**Cardinality:** 1..1

**Type:** [code](/code)

**Binding:** required:[actordefinition-actor-type](/valueset-actordefinition-actor-type)

**Summary:** true


<a id="ActorDefinition.category"></a>

## ActorDefinition.category
Further details about the type of actor

**Definition:** Further details about the type of actor.

**Cardinality:** 0..*

**Type:** [CodeableConcept](/CodeableConcept)

**Binding:** extensible:[actordefinition-actor-code](/valueset-actordefinition-actor-code)

**Summary:** true


<a id="ActorDefinition.documentation"></a>

## ActorDefinition.documentation
Explanation and details about the actor

**Definition:** Details describing the nature of the actor as well as boundaries that distinguish this type of actor from other actors.

**Comments:** The description describes what the actor is, and this element describes what the actor does (or is expected to do).

**Cardinality:** 0..1

**Type:** [markdown](/markdown)


<a id="ActorDefinition.reference"></a>

## ActorDefinition.reference
Reference to more information about the actor

**Definition:** A reference to additional documentation about the actor, but description and documentation.

**Cardinality:** 0..*

**Type:** [url](/url)


<a id="ActorDefinition.baseDefinition"></a>

## ActorDefinition.baseDefinition
Parent actor definition

**Definition:** An ActorDefinition that is a super-type of this actor.  This actor inherits all of the obligations that apply to the referenced actor definition and can be used wherever the referenced ActorDefinition can.

**Cardinality:** 0..*

**Type:** [canonical](/canonical)