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

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.

5.11.1 Scope and Usage

The ActorDefinition Resource represents an actor that can play the role of a participant in some kind of described process.

ActorDefinitions can be referenced in several places:

  • [ExampleScenarios] which show how data might flow in different situations.
  • [PlanDefinition] which defines how a workflow should/is allowed to occur amongst a set of actors.
  • [Requirements] which defines higher level expectations about system capabilities.
  • The [obligation] extension, which allows system behaviors to be defined on a per-element basis.
  • [CapabilityStatement] which allows pointing to ActorDefinitions to describe the specific sets of functionality supported by (or that should be supported by) systems (via obligations)

    • Like all canonical resources, ActorDefinitions can be defined, published and managed in ImplementationGuides and used to describe expected capabilities and roles within the IG, but can also be leveraged (via dependencies) by other implementation guides.

    5.11.2 Boundaries and Relationships

    Both ActorDefinition and CapabilityStatement> describe 'systems'. However, ActorDefinition does not presume those systems will have FHIR interfaces and does not directly speak to what the systems do, while CapabilityStatement is focused on describing the FHIR interface of a system in terms of exactly what interactions, operations, messages, etc. it can consume and produce. A CapabilityStatement may point to one or more ActorDefinitions to allow expression of the detailed data behaviors associated with a FHIR system.

    Device can also be used to represent a 'system', but the concern there is about the metadata such as manufacturer, software version, etc., not the interoperability capabilities or how it integrates with other systems.

    Patient, Practitioner, PractitionerRole and RelatedPerson can all represent individual people or animals, which ActorDefinition also does. However ActorDefinition refers to a 'type' of individual, while the others all refer to specific individuals. ActorDefinition is interested in capability, while the other resources are focused on characteristics.

    5.11.3 References to this Resource

    5.11.4 Resource Content

    Structure

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. ActorDefinition TU DomainResource A system or non-system participant involved in an information exchange process
    + 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 only - never for 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 system | non-system | individual | patient | practitioner | related-person | device | collective | care-team | group | healthcare-service | organization
    Binding: Actor Definition Actor Type (Required)
    ... documentation T 0..1 markdown Explanation and details about the actor
    ... reference 0..* url Reference to more information about the actor

    ... baseDefinition 0..* canonical(ActorDefinition) Parent actor definition


    doco Documentation for this format icon

    See the Extensions for this resource

     

    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 ActorDefinitionActorType 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 31 Resources
    description string The description of the Actor Definition ActorDefinition.description 29 Resources
    identifier token External identifier for the Actor Definition ActorDefinition.identifier 35 Resources
    jurisdiction token Intended jurisdiction for the Actor Definition ActorDefinition.jurisdiction 27 Resources
    publisher string Name of the publisher of the Actor Definition ActorDefinition.publisher 31 Resources
    status token The current status of the Actor Definition ActorDefinition.status 35 Resources
    title string The human-friendly name of the Actor Definition ActorDefinition.title 28 Resources
    type token The type of actor ActorDefinition.type
    url uri The uri that identifies the Actor Definition ActorDefinition.url 34 Resources
    version token The business version of the Actor Definition ActorDefinition.version 32 Resources