SMART Base
0.2.0 - ci-build

This page is part of the SMART Base (v0.2.0: Releases Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: SMART Guidelines Actor

Official URL: http://smart.who.int/base/StructureDefinition/SGActor Version: 0.2.0
Draft as of 2025-04-02 Computable Name: SGActor

Smart Guidelines Actor

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActorDefinition C 0..* ActorDefinition An application that exchanges data
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... title Σ 1..1 string Name for this actor definition (human friendly)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (5.0.0) (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... experimental Σ 1..1 boolean For testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... description 1..1 markdown Natural language description of the actor
ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 code person | system
Binding: ExampleScenarioActorType (5.0.0) (required): The type of actor - system or human.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ActorDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/5.0/ValueSet/publication-status|5.0.0
ActorDefinition.typerequiredExampleScenarioActorType
http://hl7.org/fhir/5.0/ValueSet/examplescenario-actor-type|5.0.0

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningActorDefinitionName 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}$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ActorDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActorDefinition 0..* ActorDefinition An application that exchanges data
... name 1..1 string Name for this actor definition (computer friendly)
... title 1..1 string Name for this actor definition (human friendly)
... status S 1..1 code draft | active | retired | unknown
... description 1..1 markdown Natural language description of the actor
... type S 1..1 code person | system

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ActorDefinition C 0..* ActorDefinition An application that exchanges data
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (5.0.0) (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this actor definition, represented as a URI (globally unique)
cnl-1: 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
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 1..1 string Name for this actor definition (computer friendly)
... title Σ 1..1 string Name for this actor definition (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (5.0.0) (required): The lifecycle status of an artifact.

... experimental Σ 1..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 1..1 markdown Natural language description of the actor
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for actor definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this actor definition is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... type SΣ 1..1 code person | system
Binding: ExampleScenarioActorType (5.0.0) (required): The type of actor - system or human.

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

Terminology Bindings

PathConformanceValueSetURI
ActorDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/5.0/ValueSet/all-languages|5.0.0
ActorDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/5.0/ValueSet/version-algorithm
ActorDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/5.0/ValueSet/publication-status|5.0.0
ActorDefinition.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/5.0/ValueSet/jurisdiction
ActorDefinition.typerequiredExampleScenarioActorType
http://hl7.org/fhir/5.0/ValueSet/examplescenario-actor-type|5.0.0

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningActorDefinitionName 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}$')
cnl-1warningActorDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ActorDefinition

Summary

Mandatory: 4 elements
Must-Support: 2 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActorDefinition C 0..* ActorDefinition An application that exchanges data
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... title Σ 1..1 string Name for this actor definition (human friendly)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (5.0.0) (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... experimental Σ 1..1 boolean For testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... description 1..1 markdown Natural language description of the actor
ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 code person | system
Binding: ExampleScenarioActorType (5.0.0) (required): The type of actor - system or human.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ActorDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/5.0/ValueSet/publication-status|5.0.0
ActorDefinition.typerequiredExampleScenarioActorType
http://hl7.org/fhir/5.0/ValueSet/examplescenario-actor-type|5.0.0

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningActorDefinitionName 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}$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from ActorDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActorDefinition 0..* ActorDefinition An application that exchanges data
... name 1..1 string Name for this actor definition (computer friendly)
... title 1..1 string Name for this actor definition (human friendly)
... status S 1..1 code draft | active | retired | unknown
... description 1..1 markdown Natural language description of the actor
... type S 1..1 code person | system

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActorDefinition C 0..* ActorDefinition An application that exchanges data
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (5.0.0) (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this actor definition, represented as a URI (globally unique)
cnl-1: 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
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 1..1 string Name for this actor definition (computer friendly)
... title Σ 1..1 string Name for this actor definition (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (5.0.0) (required): The lifecycle status of an artifact.

... experimental Σ 1..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 1..1 markdown Natural language description of the actor
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for actor definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this actor definition is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... type SΣ 1..1 code person | system
Binding: ExampleScenarioActorType (5.0.0) (required): The type of actor - system or human.

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

Terminology Bindings

PathConformanceValueSetURI
ActorDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/5.0/ValueSet/all-languages|5.0.0
ActorDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/5.0/ValueSet/version-algorithm
ActorDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/5.0/ValueSet/publication-status|5.0.0
ActorDefinition.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/5.0/ValueSet/jurisdiction
ActorDefinition.typerequiredExampleScenarioActorType
http://hl7.org/fhir/5.0/ValueSet/examplescenario-actor-type|5.0.0

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningActorDefinitionName 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}$')
cnl-1warningActorDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ActorDefinition

Summary

Mandatory: 4 elements
Must-Support: 2 elements

 

Other representations of profile: CSV, Excel, Schematron