Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon

5.11 5.10 Resource ActorDefinition - Content

Responsible Owner: FHIR Infrastructure icon Work Group Maturity Level : 1   Trial Use Normative Security Category : Anonymous Compartments : No defined compartments

Describes Provides a definition of an actor - a human system, individual, non-system device, or an application collective - that plays a role in a process, such as data exchange, and that may have obligations associated along with the role the actor plays. associated obligations.

The ActorDefinition Resource represents an actor that can plays play 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 ActorDefinitions can be referenced in descriptions and definitions of clinical business flows, though FHIR itself does not provide several places:

  • [ ExampleScenarios ] which show how data might flow in different situations.
  • [ PlanDefinition ] which defines how a business process description language, nor will it. The intention 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 ActorDefinition is specific sets of functionality supported by (or that other business process languages will refer the actors should be supported by) systems (via obligations)
  • Like all canonical resources, ActorDefinitions can be defined, published and managed in doing so, bring into scope the technical artifacts associated with ImplementationGuides and used to describe expected capabilities and roles within the actor. IG, but can also be leveraged (via dependencies) by other implementation guides.

    Once defined, Actors may be asociated with obligations Both ActorDefinition and CapabilityStatement defined > 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 profiles terms of exactly what interactions, operations, messages, etc. it can consume and produce. A CapabilityStatement may point to describe expected application behavior. one or more ActorDefinitions to allow expression of the detailed data behaviors associated with a FHIR system.

    Actors may Device can also be referenced from ExampleXcenario . 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.

    Structure

    An application that exchanges data Intended jurisdiction for Use and/or publishing 0..1 Functionality associated with Reference to more information Definition of this
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . ActorDefinition TU N 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 purposes, not 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 Jurisdiction of the authority that maintains the actor definition (if applicable)
    Binding: Jurisdiction ValueSet icon ( Extensible )

    . . . purpose T 0..1 markdown Why this actor definition is defined
    . . . copyright T 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
    . . . copyrightLabel T 0..1 string Copyright holder and year(s)
    . . . type Σ 1..1 code person | system | collective | other
    Binding: Example Scenario Actor Definition Actor Type ( Required )
    . . documentation . category T Σ 0..* markdown CodeableConcept Further details about the type of actor
    Binding: Actor Definition Actor Code ( Extensible )

    . . . reference documentation T 0..* 0..1 url markdown Explanation and details about the actor
    . . capabilities . reference 0..1 0..* canonical ( CapabilityStatement url ) CapabilityStatement for Reference to more information about the actor (if applicable)

    . . . derivedFrom baseDefinition 0..* canonical ( ActorDefinition ) Parent actor in another context / IG definition


    doco Documentation for this format icon

    See the Extensions for this resource

    UML Diagram ( Legend )

    ActorDefinition ( DomainResource ) + CanonicalResource 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 url : 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 instance identifier : 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 sequence version : string [0..1] Indicates the mechanism used to compare versions to determine which is more current versionAlgorithm[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 generation name : string [0..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the actor definition title : 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 no version of this resource will ever be used intended for genuine usage experimental : 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 changes date : dateTime [0..1] The name of the organization or individual responsible for the release and ongoing maintenance of the actor definition publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the actor description : 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 instances useContext : UsageContext [0..*] A legal or geographic region in which the actor definition authority that maintains the resource is intended to be used 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 jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) JurisdictionValueSet + » Explanation of why this actor definition is needed and why it has been designed as it has purpose : markdown [0..1] A copyright statement relating to the actor definition and/or its contents. Copyright statements are generally legal notices of intellectual property ownership and can include restrictions on the use and publishing of the actor definition copyright : 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. restricted. (e.g. 'All rights reserved', 'Some rights reserved') copyrightLabel : string [0..1] Whether the What type of actor represents a human or an appliction this is type : code [1..1] « null (Strength=Required) ExampleScenarioActorType ActorDefinitionActorType ! » Documentation Further details about the functionality type of actor category : CodeableConcept [0..*] « null (Strength=Extensible) ActorDefinitionActorCode + » Details describing the nature of the actor as well as boundaries that distinguish this type of actor from other actors documentation : markdown [0..1] A reference to additional documentation about the actor, but description and documentation reference : url [0..*] The capability statement for the actor (if the concept is applicable) capabilities : canonical [0..1] « CapabilityStatement » A url An ActorDefinition that identifies the definition is a super-type of this actor in another IG (which IG must be listed in the dependencies). actor. This actor inherits all of the obligations etc. as defined in that apply to the other IG referenced actor definition and can be used wherever the referenced ActorDefinition can derivedFrom baseDefinition : 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 only - never for 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>
    
     <jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the actor definition (if applicable) icon --></jurisdiction>
    
     <purpose value="[markdown]"/><!-- 0..1 Why this actor definition is defined -->
     <
     <
     <
     <
    
     <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use -->
     <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
     <type value="[code]"/><!-- 1..1 person | system | collective | other -->
     <category><!-- 0..* CodeableConcept Further details about the type of actor --></category>
     <documentation value="[markdown]"/><!-- 0..1 Explanation and details about the actor -->
    
     <reference value="[url]"/><!-- 0..* Reference to more information about the actor -->
     <</capabilities>
     <</derivedFrom>
    
     <baseDefinition><!-- 0..* canonical(ActorDefinition) Parent actor definition --></baseDefinition>
    
    </ActorDefinition>
    

    JSON Template

    {doco
      "resourceType" : "",
    
      "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 only - never for 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 }], // Jurisdiction of the authority that maintains the actor definition (if applicable) icon
    
      "purpose" : "<markdown>", // Why this actor definition is defined
      "
      "
      "
      "
    
      "copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
      "copyrightLabel" : "<string>", // Copyright holder and year(s)
      "type" : "<code>", // R!  person | system | collective | other
      "category" : [{ CodeableConcept }], // Further details about the type of actor
      "documentation" : "<markdown>", // Explanation and details about the actor
    
      "reference" : ["<url>"], // Reference to more information about the actor
      "
      "
    
      "baseDefinition" : ["<canonical(ActorDefinition)>"] // Parent actor definition
    
    }
    

    Turtle Template

    @prefix fhir: <http://hl7.org/fhir/> .doco
    
    
    [ a fhir:;
    
    [ a fhir:ActorDefinition;
    
      fhir:nodeRole fhir:treeRoot; # if this is the parser root
    
      # from 
      # from 
    
      # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
      # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir: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: ]
    
        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:
    
      fhir:experimental [ boolean ] ; # 0..1 For testing only - never for 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:
    
      fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the actor definition (if applicable)
    
      fhir:purpose [ markdown ] ; # 0..1 Why this actor definition is defined
      fhir:
      fhir:
      fhir:
      fhir:
    
      fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use
      fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
      fhir:type [ code ] ; # 1..1 person | system | collective | other
      fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Further details about the type of actor
      fhir:documentation [ markdown ] ; # 0..1 Explanation and details about the actor
    
      fhir:reference  ( [ url ] ... ) ; # 0..* Reference to more information about the actor
      fhir:
      fhir:
    
      fhir:baseDefinition  ( [ canonical(ActorDefinition) ] ... ) ; # 0..* Parent actor definition
    
    ]
    

    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

    An application that exchanges data Intended jurisdiction for Use and/or publishing 0..1 Functionality associated with Reference to more information Definition of this
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . ActorDefinition TU N 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 purposes, not 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 Jurisdiction of the authority that maintains the actor definition (if applicable)
    Binding: Jurisdiction ValueSet icon ( Extensible )

    . . . purpose T 0..1 markdown Why this actor definition is defined
    . . . copyright T 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
    . . . copyrightLabel T 0..1 string Copyright holder and year(s)
    . . . type Σ 1..1 code person | system | collective | other
    Binding: Example Scenario Actor Definition Actor Type ( Required )
    . . documentation . category T Σ 0..* markdown CodeableConcept Further details about the type of actor
    Binding: Actor Definition Actor Code ( Extensible )

    . . . reference documentation T 0..* 0..1 url markdown Explanation and details about the actor
    . . capabilities . reference 0..1 0..* canonical ( CapabilityStatement url ) CapabilityStatement for Reference to more information about the actor (if applicable)

    . . . derivedFrom baseDefinition 0..* canonical ( ActorDefinition ) Parent actor in another context / IG definition


    doco Documentation for this format icon

    See the Extensions for this resource

    UML Diagram ( Legend )

    ActorDefinition ( DomainResource ) + CanonicalResource 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 url : 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 instance identifier : 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 sequence version : string [0..1] Indicates the mechanism used to compare versions to determine which is more current versionAlgorithm[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 generation name : string [0..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the actor definition title : 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 no version of this resource will ever be used intended for genuine usage experimental : 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 changes date : dateTime [0..1] The name of the organization or individual responsible for the release and ongoing maintenance of the actor definition publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the actor description : 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 instances useContext : UsageContext [0..*] A legal or geographic region in which the actor definition authority that maintains the resource is intended to be used 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 jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) JurisdictionValueSet + » Explanation of why this actor definition is needed and why it has been designed as it has purpose : markdown [0..1] A copyright statement relating to the actor definition and/or its contents. Copyright statements are generally legal notices of intellectual property ownership and can include restrictions on the use and publishing of the actor definition copyright : 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. restricted. (e.g. 'All rights reserved', 'Some rights reserved') copyrightLabel : string [0..1] Whether the What type of actor represents a human or an appliction this is type : code [1..1] « null (Strength=Required) ExampleScenarioActorType ActorDefinitionActorType ! » Documentation Further details about the functionality type of actor category : CodeableConcept [0..*] « null (Strength=Extensible) ActorDefinitionActorCode + » Details describing the nature of the actor as well as boundaries that distinguish this type of actor from other actors documentation : markdown [0..1] A reference to additional documentation about the actor, but description and documentation reference : url [0..*] The capability statement for the actor (if the concept is applicable) capabilities : canonical [0..1] « CapabilityStatement » A url An ActorDefinition that identifies the definition is a super-type of this actor in another IG (which IG must be listed in the dependencies). actor. This actor inherits all of the obligations etc. as defined in that apply to the other IG referenced actor definition and can be used wherever the referenced ActorDefinition can derivedFrom baseDefinition : 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 only - never for 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>
    
     <jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the actor definition (if applicable) icon --></jurisdiction>
    
     <purpose value="[markdown]"/><!-- 0..1 Why this actor definition is defined -->
     <
     <
     <
     <
    
     <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use -->
     <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
     <type value="[code]"/><!-- 1..1 person | system | collective | other -->
     <category><!-- 0..* CodeableConcept Further details about the type of actor --></category>
     <documentation value="[markdown]"/><!-- 0..1 Explanation and details about the actor -->
    
     <reference value="[url]"/><!-- 0..* Reference to more information about the actor -->
     <</capabilities>
     <</derivedFrom>
    
     <baseDefinition><!-- 0..* canonical(ActorDefinition) Parent actor definition --></baseDefinition>
    
    </ActorDefinition>
    

    JSON Template

    {doco
      "resourceType" : "",
    
      "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 only - never for 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 }], // Jurisdiction of the authority that maintains the actor definition (if applicable) icon
    
      "purpose" : "<markdown>", // Why this actor definition is defined
      "
      "
      "
      "
    
      "copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
      "copyrightLabel" : "<string>", // Copyright holder and year(s)
      "type" : "<code>", // R!  person | system | collective | other
      "category" : [{ CodeableConcept }], // Further details about the type of actor
      "documentation" : "<markdown>", // Explanation and details about the actor
    
      "reference" : ["<url>"], // Reference to more information about the actor
      "
      "
    
      "baseDefinition" : ["<canonical(ActorDefinition)>"] // Parent actor definition
    
    }
    

    Turtle Template

    @prefix fhir: <http://hl7.org/fhir/> .doco
    
    
    [ a fhir:;
    
    [ a fhir:ActorDefinition;
    
      fhir:nodeRole fhir:treeRoot; # if this is the parser root
    
      # from 
      # from 
    
      # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
      # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir: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: ]
    
        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:
    
      fhir:experimental [ boolean ] ; # 0..1 For testing only - never for 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:
    
      fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the actor definition (if applicable)
    
      fhir:purpose [ markdown ] ; # 0..1 Why this actor definition is defined
      fhir:
      fhir:
      fhir:
      fhir:
    
      fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use
      fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
      fhir:type [ code ] ; # 1..1 person | system | collective | other
      fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Further details about the type of actor
      fhir:documentation [ markdown ] ; # 0..1 Explanation and details about the actor
    
      fhir:reference  ( [ url ] ... ) ; # 0..* Reference to more information about the actor
      fhir:
      fhir:
    
      fhir:baseDefinition  ( [ canonical(ActorDefinition) ] ... ) ; # 0..* Parent actor definition
    
    ]
    

    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

    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 icon 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 ActorDefinitionActorType Required

    The type of actor - system or human.

    ActorDefinition.category ActorDefinitionActorCode Extensible

    Code for the type of actor - system or human.

    UniqueKey Level Location Description Expression
    img  cnl-0 Warning (base) 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}$')
    img  cnl-1 Warning ActorDefinition.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')

    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 24 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 24 Resources
    context-type token A type of use context assigned to the Actor Definition ActorDefinition.useContext.code 30 24 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 24 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 24 Resources
    date date The Actor Definition publication date ActorDefinition.date 30 25 Resources
    description string The description of the Actor Definition ActorDefinition.description 28 23 Resources
    experimental token Whether the ActorDefinition is experimental ActorDefinition.experimental
    identifier token External identifier for the Actor Definition ActorDefinition.identifier 34 28 Resources
    jurisdiction token Intended jurisdiction for Jurisdiction of the authority that maintains the the Actor Definition ActorDefinition.jurisdiction 26 21 Resources
    publisher string Name of the publisher of the Actor Definition ActorDefinition.publisher 30 25 Resources
    status token The current status of the Actor Definition ActorDefinition.status 35 28 Resources
    title string The human-friendly name of the Actor Definition ActorDefinition.title 27 23 Resources
    type token The type of actor ActorDefinition.type
    url uri The uri that identifies the Actor Definition ActorDefinition.url 34 29 Resources
    version token The business version of the Actor Definition ActorDefinition.version 30 26 Resources