SMART Base
0.1.1 - ci-build

SMART Base, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-base/ and changes regularly. See the Directory of published versions

Resource Profile: SGTransactionDefinition

Official URL: http://smart.who.int/base/StructureDefinition/SGTransactionDefinition Version: 0.1.1
Draft as of 2024-06-12 Computable Name: SGTransactionDefinition

SMART Guidelines Transaction Definition

Usage:

Formal Views of Profile Content

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

This structure is derived from SGGraphDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition 0..* SGGraphDefinition Definition of a graph of resources
... node 1..2 BackboneElement Potential target for the link
... link 1..1 BackboneElement Links this graph makes rules about

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition C 0..* SGGraphDefinition Definition of a graph of resources
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
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... title Σ 1..1 string Name for this graph definition (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 1..1 boolean For testing purposes, not real usage
... description 1..1 markdown Natural language description of the graph definition
... node 1..2 BackboneElement Potential target for the link
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... actor S 1..* Reference(SGActor) Extension
URL: http://smart.who.int/base/StructureDefinition/Sgactorext
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nodeId 1..1 id Internal ID - target for link references
.... type 1..1 code Type of resource this link refers to
Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding
... link 1..1 BackboneElement Links this graph makes rules about
.... Slices for extension 4..* Extension Extension
Slice: Unordered, Open by value:url
..... code S 1..1 Coding Extension
URL: http://smart.who.int/base/StructureDefinition/Sgcode
..... triggerEvents S 1..1 markdown Extension
URL: http://smart.who.int/base/StructureDefinition/Markdown
..... messageSemantics S 1..1 markdown Extension
URL: http://smart.who.int/base/StructureDefinition/Markdown
..... expectedActions S 1..1 markdown Extension
URL: http://smart.who.int/base/StructureDefinition/Markdown
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sourceId 1..1 id Source Node for this link
.... targetId 1..1 id Target Node for this link

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GraphDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
GraphDefinition.node.typerequiredVersionIndependentResourceTypesAll
http://hl7.org/fhir/ValueSet/version-independent-all-resource-types|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningGraphDefinitionName 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition C 0..* SGGraphDefinition Definition of a graph of resources
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 (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... 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 graph 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 GraphDefinition (business identifier)
... version Σ 0..1 string Business version of the graph definition
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Name for this graph definition (computer friendly)
... title Σ 1..1 string Name for this graph definition (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (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 graph definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for graph definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this graph definition is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... start 0..1 id Starting Node
... node 1..2 BackboneElement Potential target for the link
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... actor S 1..* Reference(SGActor) Extension
URL: http://smart.who.int/base/StructureDefinition/Sgactorext
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nodeId 1..1 id Internal ID - target for link references
.... description 0..1 string Why this node is specified
.... type 1..1 code Type of resource this link refers to
Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding
.... profile 0..1 canonical(StructureDefinition) Profile for the target resource
... link 1..1 BackboneElement Links this graph makes rules about
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 4..* Extension Extension
Slice: Unordered, Open by value:url
..... code S 1..1 Coding Extension
URL: http://smart.who.int/base/StructureDefinition/Sgcode
..... triggerEvents S 1..1 markdown Extension
URL: http://smart.who.int/base/StructureDefinition/Markdown
..... messageSemantics S 1..1 markdown Extension
URL: http://smart.who.int/base/StructureDefinition/Markdown
..... expectedActions S 1..1 markdown Extension
URL: http://smart.who.int/base/StructureDefinition/Markdown
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 0..1 string Why this link is specified
.... min 0..1 integer Minimum occurrences for this link
.... max 0..1 string Maximum occurrences for this link
.... sourceId 1..1 id Source Node for this link
.... path 0..1 string Path in the resource that contains the link
.... sliceName 0..1 string Which slice (if profiled)
.... targetId 1..1 id Target Node for this link
.... params 0..1 string Criteria for reverse lookup
.... compartment 0..* BackboneElement Compartment Consistency Rules
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... use 1..1 code where | requires
Binding: GraphCompartmentUse (required)
..... rule 1..1 code identical | matching | different | custom
Binding: GraphCompartmentRule (required)
..... code 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device | EpisodeOfCare
Binding: CompartmentType (required)
..... expression 0..1 string Custom rule, as a FHIRPath expression
..... description 0..1 string Documentation for FHIRPath expression

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GraphDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
GraphDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
GraphDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
GraphDefinition.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
GraphDefinition.node.typerequiredVersionIndependentResourceTypesAll
http://hl7.org/fhir/ValueSet/version-independent-all-resource-types|5.0.0
from the FHIR Standard
GraphDefinition.link.compartment.userequiredGraphCompartmentUse
http://hl7.org/fhir/ValueSet/graph-compartment-use|5.0.0
from the FHIR Standard
GraphDefinition.link.compartment.rulerequiredGraphCompartmentRule
http://hl7.org/fhir/ValueSet/graph-compartment-rule|5.0.0
from the FHIR Standard
GraphDefinition.link.compartment.coderequiredCompartmentType
http://hl7.org/fhir/ValueSet/compartment-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningGraphDefinitionName 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-1warningGraphDefinition.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 SGGraphDefinition

Summary

Differential View

This structure is derived from SGGraphDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition 0..* SGGraphDefinition Definition of a graph of resources
... node 1..2 BackboneElement Potential target for the link
... link 1..1 BackboneElement Links this graph makes rules about

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition C 0..* SGGraphDefinition Definition of a graph of resources
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
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... title Σ 1..1 string Name for this graph definition (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 1..1 boolean For testing purposes, not real usage
... description 1..1 markdown Natural language description of the graph definition
... node 1..2 BackboneElement Potential target for the link
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... actor S 1..* Reference(SGActor) Extension
URL: http://smart.who.int/base/StructureDefinition/Sgactorext
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nodeId 1..1 id Internal ID - target for link references
.... type 1..1 code Type of resource this link refers to
Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding
... link 1..1 BackboneElement Links this graph makes rules about
.... Slices for extension 4..* Extension Extension
Slice: Unordered, Open by value:url
..... code S 1..1 Coding Extension
URL: http://smart.who.int/base/StructureDefinition/Sgcode
..... triggerEvents S 1..1 markdown Extension
URL: http://smart.who.int/base/StructureDefinition/Markdown
..... messageSemantics S 1..1 markdown Extension
URL: http://smart.who.int/base/StructureDefinition/Markdown
..... expectedActions S 1..1 markdown Extension
URL: http://smart.who.int/base/StructureDefinition/Markdown
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sourceId 1..1 id Source Node for this link
.... targetId 1..1 id Target Node for this link

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GraphDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
GraphDefinition.node.typerequiredVersionIndependentResourceTypesAll
http://hl7.org/fhir/ValueSet/version-independent-all-resource-types|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningGraphDefinitionName 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition C 0..* SGGraphDefinition Definition of a graph of resources
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 (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... 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 graph 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 GraphDefinition (business identifier)
... version Σ 0..1 string Business version of the graph definition
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Name for this graph definition (computer friendly)
... title Σ 1..1 string Name for this graph definition (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (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 graph definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for graph definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this graph definition is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... start 0..1 id Starting Node
... node 1..2 BackboneElement Potential target for the link
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... actor S 1..* Reference(SGActor) Extension
URL: http://smart.who.int/base/StructureDefinition/Sgactorext
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nodeId 1..1 id Internal ID - target for link references
.... description 0..1 string Why this node is specified
.... type 1..1 code Type of resource this link refers to
Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)

Additional BindingsPurpose
AllResourceTypes UI Binding
.... profile 0..1 canonical(StructureDefinition) Profile for the target resource
... link 1..1 BackboneElement Links this graph makes rules about
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 4..* Extension Extension
Slice: Unordered, Open by value:url
..... code S 1..1 Coding Extension
URL: http://smart.who.int/base/StructureDefinition/Sgcode
..... triggerEvents S 1..1 markdown Extension
URL: http://smart.who.int/base/StructureDefinition/Markdown
..... messageSemantics S 1..1 markdown Extension
URL: http://smart.who.int/base/StructureDefinition/Markdown
..... expectedActions S 1..1 markdown Extension
URL: http://smart.who.int/base/StructureDefinition/Markdown
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 0..1 string Why this link is specified
.... min 0..1 integer Minimum occurrences for this link
.... max 0..1 string Maximum occurrences for this link
.... sourceId 1..1 id Source Node for this link
.... path 0..1 string Path in the resource that contains the link
.... sliceName 0..1 string Which slice (if profiled)
.... targetId 1..1 id Target Node for this link
.... params 0..1 string Criteria for reverse lookup
.... compartment 0..* BackboneElement Compartment Consistency Rules
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... use 1..1 code where | requires
Binding: GraphCompartmentUse (required)
..... rule 1..1 code identical | matching | different | custom
Binding: GraphCompartmentRule (required)
..... code 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device | EpisodeOfCare
Binding: CompartmentType (required)
..... expression 0..1 string Custom rule, as a FHIRPath expression
..... description 0..1 string Documentation for FHIRPath expression

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GraphDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
GraphDefinition.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
GraphDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
GraphDefinition.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
GraphDefinition.node.typerequiredVersionIndependentResourceTypesAll
http://hl7.org/fhir/ValueSet/version-independent-all-resource-types|5.0.0
from the FHIR Standard
GraphDefinition.link.compartment.userequiredGraphCompartmentUse
http://hl7.org/fhir/ValueSet/graph-compartment-use|5.0.0
from the FHIR Standard
GraphDefinition.link.compartment.rulerequiredGraphCompartmentRule
http://hl7.org/fhir/ValueSet/graph-compartment-rule|5.0.0
from the FHIR Standard
GraphDefinition.link.compartment.coderequiredCompartmentType
http://hl7.org/fhir/ValueSet/compartment-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningGraphDefinitionName 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-1warningGraphDefinition.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 SGGraphDefinition

Summary

 

Other representations of profile: CSV, Excel, Schematron