SMART App Launch
2.2.0-ballot - CI-Build International flag

This page is part of the Smart App Launch Implementation Guide (v2.2.0-ballot: STU 2.2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.1.0. 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-ballot
Active as of 2023-12-19 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..*BasicResource for non-supported content
... extension
.... extension 0..0
.... value[x] 0..1stringValue of extension
... code
.... coding 1..1CodingCode defined by a terminology system

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

.... coding Σ1..1CodingCode defined by a terminology system

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Basic.codeexampleBasicResourceTypes

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..*BasicResource for non-supported content
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1stringValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: BasicResourceTypes (example): Codes for identifying types of resources not yet defined by FHIR.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..1CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)Who created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Basic.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Basic.codeexampleBasicResourceTypes

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..*BasicResource for non-supported content
... extension
.... extension 0..0
.... value[x] 0..1stringValue of extension
... code
.... coding 1..1CodingCode defined by a terminology system

doco Documentation for this format

Key Elements View

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

.... coding Σ1..1CodingCode defined by a terminology system

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Basic.codeexampleBasicResourceTypes

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..*BasicResource for non-supported content
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1stringValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: BasicResourceTypes (example): Codes for identifying types of resources not yet defined by FHIR.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..1CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)Who created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Basic.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Basic.codeexampleBasicResourceTypes

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