SMART App Launch
2.2.0 - STU 2.2 International flag

This page is part of the Smart App Launch Implementation Guide (v2.2.0: STU 2.2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: SMART App State

Official URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/smart-app-state-basic Version: 2.2.0
Active as of 2024-04-30 Computable Name: SMARTAppStateBasic

SMART App State profile on Basic resource

See App State capability for requirements, usage notes, and examples.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Basic

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic 0..* Basic Resource for non-supported content
... extension
.... extension 0..0
.... value[x] 0..1 string Value of extension
... code
.... coding 1..1 Coding Code defined by a terminology system

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic 0..* Basic Resource for non-supported content
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code ?!Σ 1..1 CodeableConcept Kind of Resource
Binding: BasicResourceTypes (example): Codes for identifying types of resources not yet defined by FHIR.

.... coding Σ 1..1 Coding Code defined by a terminology system

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Basic.codeexampleBasicResourceTypes
http://hl7.org/fhir/ValueSet/basic-resource-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorBasicIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBasicIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBasicIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorBasicIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBasicA resource should have narrative for robust management
: text.`div`.exists()
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
.. Basic 0..* Basic Resource for non-supported content
... 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
... 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri identifies the meaning of the extension
.... value[x] 0..1 string Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... code ?!Σ 1..1 CodeableConcept Kind of Resource
Binding: BasicResourceTypes (example): Codes for identifying types of resources not yet defined by FHIR.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference(Resource) Identifies the focus of this resource
... created Σ 0..1 date When created
... author Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) Who created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Basic.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Basic.codeexampleBasicResourceTypes
http://hl7.org/fhir/ValueSet/basic-resource-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorBasicIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBasicIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBasicIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorBasicIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBasicA resource should have narrative for robust management
: text.`div`.exists()
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 Basic

Summary

Mandatory: 1 element
Prohibited: 1 element

Differential View

This structure is derived from Basic

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic 0..* Basic Resource for non-supported content
... extension
.... extension 0..0
.... value[x] 0..1 string Value of extension
... code
.... coding 1..1 Coding Code defined by a terminology system

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic 0..* Basic Resource for non-supported content
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code ?!Σ 1..1 CodeableConcept Kind of Resource
Binding: BasicResourceTypes (example): Codes for identifying types of resources not yet defined by FHIR.

.... coding Σ 1..1 Coding Code defined by a terminology system

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Basic.codeexampleBasicResourceTypes
http://hl7.org/fhir/ValueSet/basic-resource-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorBasicIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBasicIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBasicIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorBasicIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBasicA resource should have narrative for robust management
: text.`div`.exists()
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
.. Basic 0..* Basic Resource for non-supported content
... 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
... 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri identifies the meaning of the extension
.... value[x] 0..1 string Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... code ?!Σ 1..1 CodeableConcept Kind of Resource
Binding: BasicResourceTypes (example): Codes for identifying types of resources not yet defined by FHIR.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference(Resource) Identifies the focus of this resource
... created Σ 0..1 date When created
... author Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) Who created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Basic.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Basic.codeexampleBasicResourceTypes
http://hl7.org/fhir/ValueSet/basic-resource-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorBasicIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBasicIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBasicIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorBasicIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBasicA resource should have narrative for robust management
: text.`div`.exists()
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 Basic

Summary

Mandatory: 1 element
Prohibited: 1 element

 

Other representations of profile: CSV, Excel, Schematron