UserAccessEndpoint

User Access Endpoint Profile

activeSMART App Launch2.2.0resource10 key elements

Profile on Endpoint associated with a User Access Brand.

For background and context, see [User Access Brands Overview](brands.html#endpoint-profile).

In addition to the core data elements on Endpoint, one key extension is used in this profile:

  • <http://hl7.org/fhir/StructureDefinition/endpoint-fhir-version> conveys is a denormalization to help clients focus on supported endpoints. The `valueCode` is any version from http://hl7.org/fhir/valueset-FHIR-version.html (e.g., `4.0.1` is expected for FHIR R4 endpoints).

Notes: * `0..1` `name` Conveys a fallback or default name describing the endpoint and the organization offering User API access at this endpoint. This value MAY contain technical details like FHIR API Version designations and apps SHOULD preferentially use names from an associated `UserAccessBrand` rather than displaying this value to users. * `1..* MS` `contact` website where developers can configure access to this endpoint, providing at least one `"system": "url"` contact point where the `value` is an `https://` URL intended for app developers * `1..1 MS` `address` FHIR base URL for server supporting user access

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-endpoint
ID
user-access-endpoint
Type
Base Definition
Derivation
constraint
Mandatory and Must-Support Elements

Elements with cardinality > 0 or marked as Must Support (S)

PathCard.TypeFlagsDescription
extension
1+
:fhir-version1..*
Extension
S1+
Endpoint FHIR Version
status
S
connectionType
S
contact
S1+
Contact information for the endpoint.
:configuration-url1..*
S1+
Website where developers can configure access to this endpoint
contact.system
S1+
contact.value
S1+
an https:// URL for app developers
payloadType
S
address
S
FHIR base URL for servers supporting user access