SMART Exposed Extension

Canonical	../StructureDefinition/smart-exposed
Status	draft · 1.26.0
Base	Extension (constraint)
Context	StructureDefinition (element)
Source	FSH · JSON

Declares that this profile's resource type is reachable by a SMART on FHIR app, and names the platform permission required for each operation. Exposure is an authorization decision recorded in the IG, deliberately separate from whether the resource happens to be profiled.

Elements / Details

Every element this profile touches, with its full definition. Element names in the tables link here.

Extension

Short	SMART Exposed
Definition	Declares that this profile's resource type is reachable by a SMART on FHIR app, and names the platform permission required for each operation. Exposure is an authorization decision recorded in the IG, deliberately separate from whether the resource happens to be profiled.
Cardinality	0..*
Invariants	ele-1, ext-1

Extension.id

Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	http://hl7.org/fhirpath/System.String

Extension.extension

Short	Additional content defined by implementations
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality	1..*
Type	Extension
Invariants	ele-1, ext-1
Also called	extensions, user content

Extension.extension:read

Short	The permission required to read or search this resource
Definition	Required. A resource that cannot be read cannot meaningfully be exposed over SMART, so the presence of this extension always implies at least read access.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality	1..1
Type	Extension
Must Support	yes
Invariants	ele-1, ext-1
Also called	extensions, user content

Extension.extension:read.id

Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	http://hl7.org/fhirpath/System.String

Extension.extension:read.extension

Short	Additional content defined by implementations
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality	0..0
Type	Extension
Invariants	ele-1, ext-1
Also called	extensions, user content

Extension.extension:read.url

Short	identifies the meaning of the extension
Definition	Source of the definition for the extension code - a logical name or a URL.
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Cardinality	1..1
Type	http://hl7.org/fhirpath/System.String
Fixed value	read

Extension.extension:read.value[x]

Short	Value of extension
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Cardinality	0..1
Type	string
Invariants	ele-1

Extension.extension:write

Short	The permission required to create or update this resource (omit for read-only exposure)
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality	0..1
Type	Extension
Invariants	ele-1, ext-1
Also called	extensions, user content

Extension.extension:write.id

Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	http://hl7.org/fhirpath/System.String

Extension.extension:write.extension

Short	Additional content defined by implementations
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality	0..0
Type	Extension
Invariants	ele-1, ext-1
Also called	extensions, user content

Extension.extension:write.url

Short	identifies the meaning of the extension
Definition	Source of the definition for the extension code - a logical name or a URL.
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Cardinality	1..1
Type	http://hl7.org/fhirpath/System.String
Fixed value	write

Extension.extension:write.value[x]

Short	Value of extension
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Cardinality	0..1
Type	string
Invariants	ele-1

Extension.extension:delete

Short	The permission required to delete this resource (omit if deletion is not exposed)
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality	0..1
Type	Extension
Invariants	ele-1, ext-1
Also called	extensions, user content

Extension.extension:delete.id

Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	http://hl7.org/fhirpath/System.String

Extension.extension:delete.extension

Short	Additional content defined by implementations
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality	0..0
Type	Extension
Invariants	ele-1, ext-1
Also called	extensions, user content

Extension.extension:delete.url

Short	identifies the meaning of the extension
Definition	Source of the definition for the extension code - a logical name or a URL.
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Cardinality	1..1
Type	http://hl7.org/fhirpath/System.String
Fixed value	delete

Extension.extension:delete.value[x]

Short	Value of extension
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Cardinality	0..1
Type	string
Invariants	ele-1

Extension.url

Short	identifies the meaning of the extension
Definition	Source of the definition for the extension code - a logical name or a URL.
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Cardinality	1..1
Type	http://hl7.org/fhirpath/System.String
Fixed value	../StructureDefinition/smart-exposed

Extension.value[x]

Short	Value of extension
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Cardinality	0..0
Type	base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Invariants	ele-1