FHIR CI-Build

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

FHIR Infrastructure icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the ActorDefinition resource.

ActorDefinition
Element IdActorDefinition
Definition

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.

Short DisplayAn application that exchanges data
Cardinality0..*
TypeCanonicalResource
Summaryfalse
Invariants
Defined on this element
cnl-0Warning 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}')
ActorDefinition.url
Element IdActorDefinition.url
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.

Short DisplayCanonical identifier for this actor definition, represented as a URI (globally unique)
Cardinality0..1
Typeuri
Requirements

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

Summarytrue
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.

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 element to indicate where the current master source of the resource can be found.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')
ActorDefinition.identifier
Element IdActorDefinition.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.

Short DisplayAdditional identifier for the actor definition (business identifier)
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

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

Summarytrue
ActorDefinition.version
Element IdActorDefinition.version
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.

Short DisplayBusiness version of the actor definition
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
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.

ActorDefinition.name
Element IdActorDefinition.name
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.

Short DisplayName for this actor definition (computer friendly)
Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
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.

Invariants
Affect this element
cnl-0Warning 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}')
ActorDefinition.title
Element IdActorDefinition.title
Definition

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

Short DisplayName for this actor definition (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

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

ActorDefinition.status
Element IdActorDefinition.status
Definition

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

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because designs and applications should not use a retired ActorDefinition without due consideration)
Summarytrue
Comments

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

ActorDefinition.experimental
Element IdActorDefinition.experimental
Definition

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 usage.

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Requirements

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

Summarytrue
Comments

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

ActorDefinition.date
Element IdActorDefinition.date
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.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
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.

ActorDefinition.publisher
Element IdActorDefinition.publisher
Definition

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

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

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

Summarytrue
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.

ActorDefinition.contact
Element IdActorDefinition.contact
Definition

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

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

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

ActorDefinition.description
Element IdActorDefinition.description
Definition

A free text natural language description of the actor.

Short DisplayNatural language description of the actor
Cardinality0..1
Typemarkdown
Alternate NamesScope; Purpose
Summaryfalse
Comments

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

ActorDefinition.useContext
Element IdActorDefinition.useContext
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.

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

ActorDefinition.jurisdiction
Element IdActorDefinition.jurisdiction
Definition

A legal or geographic region in which the actor definition is intended to be used.

Short DisplayIntended jurisdiction for actor definition (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
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.

ActorDefinition.purpose
Element IdActorDefinition.purpose
Definition

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

Short DisplayWhy this actor definition is defined
Cardinality0..1
Typemarkdown
Summaryfalse
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.

ActorDefinition.copyright
Element IdActorDefinition.copyright
Definition

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 definition.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

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

Alternate NamesLicense; Restrictions
Summaryfalse
Comments

...

ActorDefinition.copyrightLabel
Element IdActorDefinition.copyrightLabel
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 resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

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

Summaryfalse
Comments

The (c) symbol 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.

ActorDefinition.type
Element IdActorDefinition.type
Definition

Whether the actor represents a human or an appliction.

Short Displayperson | system
Cardinality1..1
Terminology BindingExampleScenarioActorType (Required)
Typecode
Summarytrue
ActorDefinition.documentation
Element IdActorDefinition.documentation
Definition

Documentation about the functionality of the actor.

Short DisplayFunctionality associated with the actor
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

In general terms, the description desribes what the actor is, and this element describes what the actor does (or is expected to do).

ActorDefinition.reference
Element IdActorDefinition.reference
Definition

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

Short DisplayReference to more information about the actor
Cardinality0..*
Typeurl
Summaryfalse
ActorDefinition.capabilities
Element IdActorDefinition.capabilities
Definition

The capability statement for the actor (if the concept is applicable).

Short DisplayCapabilityStatement for the actor (if applicable)
Cardinality0..1
Typecanonical(CapabilityStatement)
Summaryfalse
ActorDefinition.derivedFrom
Element IdActorDefinition.derivedFrom
Definition

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 IG.

Short DisplayDefinition of this actor in another context / IG
Cardinality0..*
Typecanonical(ActorDefinition)
Summaryfalse