FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

5.11 Resource ActorDefinition - Content

FHIR Infrastructure icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: No defined compartments

Describes an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.

5.11.1 Scope and Usage

The ActorDefinition Resource an actor that can plays the role of a participant in some kind of described process. Generally, in the scope of FHIR, the process is some kind of data exchange, and ActorDefinition is defined for this purpose.

However it's also possible to use actors in descriptions and definitions of clinical business flows, though FHIR itself does not provide a business process description language, nor will it. The intention of the ActorDefinition is that other business process languages will refer the actors and in doing so, bring into scope the technical artifacts associated with the actor.

5.11.2 Boundaries and Relationships

Once defined, Actors may be asociated with obligations defined in profiles to describe expected application behavior.

Actors may also be referenced from ExampleXcenario.

5.11.3 References to this Resource

5.11.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActorDefinition TU DomainResource An application that exchanges data
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
... url ΣC 0..1 uri Canonical identifier for this actor definition, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the actor definition (business identifier)

... version Σ 0..1 string Business version of the actor definition
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this actor definition (computer friendly)
... title ΣT 0..1 string Name for this actor definition (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher ΣT 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher

... description T 0..1 markdown Natural language description of the actor
... useContext ΣTU 0..* UsageContext The context that the content is intended to support

... jurisdiction ΣXD 0..* CodeableConcept Intended jurisdiction for actor definition (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T 0..1 markdown Why this actor definition is defined
... copyright T 0..1 markdown Use and/or publishing restrictions
... copyrightLabel T 0..1 string Copyright holder and year(s)
... type Σ 1..1 code person | system
Binding: Example Scenario Actor Type (Required)
... documentation T 0..1 markdown Functionality associated with the actor
... reference 0..* url Reference to more information about the actor

... capabilities 0..1 canonical(CapabilityStatement) CapabilityStatement for the actor (if applicable)
... derivedFrom 0..* canonical(ActorDefinition) Definition of this actor in another context / IG


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

ActorDefinition (DomainResource) +CanonicalResourceAn 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 serversurl : uri [0..1]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 instanceidentifier : Identifier [0..*]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 sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »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 generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the actor definitiontitle : string [0..1]The status of this actor definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this actor definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]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 changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the actor definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the actordescription : markdown [0..1]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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the actor definition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this actor definition is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the actor definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the actor definitioncopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]Whether the actor represents a human or an applictiontype : code [1..1] « null (Strength=Required)ExampleScenarioActorType! »Documentation about the functionality of the actordocumentation : markdown [0..1]A reference to additional documentation about the actor, but description and documentationreference : url [0..*]The capability statement for the actor (if the concept is applicable)capabilities : canonical [0..1] « CapabilityStatement »A url that identifies the definition of this actor in another IG (which IG must be listed in the dependencies). This actor inherits all the obligations etc. as defined in the other IGderivedFrom : canonical [0..*] « ActorDefinition »

XML Template

<ActorDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this actor definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the actor definition (business identifier) --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the actor definition -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this actor definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this actor definition (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the actor -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for actor definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this actor definition is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <type value="[code]"/><!-- 1..1 person | system -->
 <documentation value="[markdown]"/><!-- 0..1 Functionality associated with the actor -->
 <reference value="[url]"/><!-- 0..* Reference to more information about the actor -->
 <capabilities><!-- 0..1 canonical(CapabilityStatement) CapabilityStatement for the actor (if applicable) --></capabilities>
 <derivedFrom><!-- 0..* canonical(ActorDefinition) Definition of this actor in another context / IG --></derivedFrom>
</ActorDefinition>

JSON Template

{doco
  "resourceType" : "ActorDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this actor definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the actor definition (business identifier)
  "version" : "<string>", // Business version of the actor definition
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this actor definition (computer friendly)
  "title" : "<string>", // Name for this actor definition (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the actor
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for actor definition (if applicable)
  "purpose" : "<markdown>", // Why this actor definition is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "type" : "<code>", // R!  person | system
  "documentation" : "<markdown>", // Functionality associated with the actor
  "reference" : ["<url>"], // Reference to more information about the actor
  "capabilities" : "<canonical(CapabilityStatement)>", // CapabilityStatement for the actor (if applicable)
  "derivedFrom" : ["<canonical(ActorDefinition)>"] // Definition of this actor in another context / IG
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ActorDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this actor definition, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the actor definition (business identifier)
  fhir:version [ string ] ; # 0..1 Business version of the actor definition
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this actor definition (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this actor definition (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the actor
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for actor definition (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this actor definition is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:type [ code ] ; # 1..1 person | system
  fhir:documentation [ markdown ] ; # 0..1 Functionality associated with the actor
  fhir:reference  ( [ url ] ... ) ; # 0..* Reference to more information about the actor
  fhir:capabilities [ canonical(CapabilityStatement) ] ; # 0..1 CapabilityStatement for the actor (if applicable)
  fhir:derivedFrom  ( [ canonical(ActorDefinition) ] ... ) ; # 0..* Definition of this actor in another context / IG
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActorDefinition TU DomainResource An application that exchanges data
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
... url ΣC 0..1 uri Canonical identifier for this actor definition, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the actor definition (business identifier)

... version Σ 0..1 string Business version of the actor definition
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this actor definition (computer friendly)
... title ΣT 0..1 string Name for this actor definition (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher ΣT 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher

... description T 0..1 markdown Natural language description of the actor
... useContext ΣTU 0..* UsageContext The context that the content is intended to support

... jurisdiction ΣXD 0..* CodeableConcept Intended jurisdiction for actor definition (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T 0..1 markdown Why this actor definition is defined
... copyright T 0..1 markdown Use and/or publishing restrictions
... copyrightLabel T 0..1 string Copyright holder and year(s)
... type Σ 1..1 code person | system
Binding: Example Scenario Actor Type (Required)
... documentation T 0..1 markdown Functionality associated with the actor
... reference 0..* url Reference to more information about the actor

... capabilities 0..1 canonical(CapabilityStatement) CapabilityStatement for the actor (if applicable)
... derivedFrom 0..* canonical(ActorDefinition) Definition of this actor in another context / IG


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

ActorDefinition (DomainResource) +CanonicalResourceAn 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 serversurl : uri [0..1]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 instanceidentifier : Identifier [0..*]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 sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »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 generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the actor definitiontitle : string [0..1]The status of this actor definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this actor definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]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 changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the actor definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the actordescription : markdown [0..1]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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the actor definition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this actor definition is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the actor definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the actor definitioncopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]Whether the actor represents a human or an applictiontype : code [1..1] « null (Strength=Required)ExampleScenarioActorType! »Documentation about the functionality of the actordocumentation : markdown [0..1]A reference to additional documentation about the actor, but description and documentationreference : url [0..*]The capability statement for the actor (if the concept is applicable)capabilities : canonical [0..1] « CapabilityStatement »A url that identifies the definition of this actor in another IG (which IG must be listed in the dependencies). This actor inherits all the obligations etc. as defined in the other IGderivedFrom : canonical [0..*] « ActorDefinition »

XML Template

<ActorDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this actor definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the actor definition (business identifier) --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the actor definition -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this actor definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this actor definition (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the actor -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for actor definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this actor definition is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <type value="[code]"/><!-- 1..1 person | system -->
 <documentation value="[markdown]"/><!-- 0..1 Functionality associated with the actor -->
 <reference value="[url]"/><!-- 0..* Reference to more information about the actor -->
 <capabilities><!-- 0..1 canonical(CapabilityStatement) CapabilityStatement for the actor (if applicable) --></capabilities>
 <derivedFrom><!-- 0..* canonical(ActorDefinition) Definition of this actor in another context / IG --></derivedFrom>
</ActorDefinition>

JSON Template

{doco
  "resourceType" : "ActorDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this actor definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the actor definition (business identifier)
  "version" : "<string>", // Business version of the actor definition
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this actor definition (computer friendly)
  "title" : "<string>", // Name for this actor definition (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the actor
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for actor definition (if applicable)
  "purpose" : "<markdown>", // Why this actor definition is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "type" : "<code>", // R!  person | system
  "documentation" : "<markdown>", // Functionality associated with the actor
  "reference" : ["<url>"], // Reference to more information about the actor
  "capabilities" : "<canonical(CapabilityStatement)>", // CapabilityStatement for the actor (if applicable)
  "derivedFrom" : ["<canonical(ActorDefinition)>"] // Definition of this actor in another context / IG
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ActorDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this actor definition, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the actor definition (business identifier)
  fhir:version [ string ] ; # 0..1 Business version of the actor definition
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this actor definition (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this actor definition (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the actor
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for actor definition (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this actor definition is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:type [ code ] ; # 1..1 person | system
  fhir:documentation [ markdown ] ; # 0..1 Functionality associated with the actor
  fhir:reference  ( [ url ] ... ) ; # 0..* Reference to more information about the actor
  fhir:capabilities [ canonical(CapabilityStatement) ] ; # 0..1 CapabilityStatement for the actor (if applicable)
  fhir:derivedFrom  ( [ canonical(ActorDefinition) ] ... ) ; # 0..* Definition of this actor in another context / IG
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

5.11.4.1 Terminology Bindings

Path ValueSet Type Documentation
ActorDefinition.versionAlgorithm[x] VersionAlgorithm Extensible

Indicates the mechanism used to compare versions to determine which is more current.
ActorDefinition.status PublicationStatus Required

The lifecycle status of an artifact.
ActorDefinition.jurisdiction JurisdictionValueSet Extensible

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.
ActorDefinition.type ExampleScenarioActorType Required

The type of actor - system or human.

5.11.4.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
img cnl-1Warning ActorDefinition.urlURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')

5.11.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
context token A use context assigned to the Actor Definition (ActorDefinition.useContext.value.ofType(CodeableConcept)) 30 Resources
context-quantity quantity A quantity- or range-valued use context assigned to the Actor Definition (ActorDefinition.useContext.value.ofType(Quantity)) | (ActorDefinition.useContext.value.ofType(Range)) 30 Resources
context-type token A type of use context assigned to the Actor Definition ActorDefinition.useContext.code 30 Resources
context-type-quantity composite A use context type and quantity- or range-based value assigned to the Actor Definition On ActorDefinition.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range)		 30 Resources
context-type-value composite A use context type and value assigned to the Actor Definition On ActorDefinition.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)		 30 Resources
date date The Actor Definition publication date ActorDefinition.date 30 Resources
description string The description of the Actor Definition ActorDefinition.description 28 Resources
identifier token External identifier for the Actor Definition ActorDefinition.identifier 36 Resources
jurisdiction token Intended jurisdiction for the Actor Definition ActorDefinition.jurisdiction 26 Resources
publisher string Name of the publisher of the Actor Definition ActorDefinition.publisher 30 Resources
status token The current status of the Actor Definition ActorDefinition.status 36 Resources
title string The human-friendly name of the Actor Definition ActorDefinition.title 27 Resources
type token The type of actor ActorDefinition.type
url uri The uri that identifies the Actor Definition ActorDefinition.url 35 Resources
version token The business version of the Actor Definition ActorDefinition.version 31 Resources