R4 Ballot #1 (Mixed Normative/Trial use)
ConformanceThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R4B R4
| FHIR Infrastructure Work Group | Maturity Level: 1 | Informative | Use Context: Any |
Detailed Descriptions for the elements in the extension.
| Extension | |
| Element Id | Extension |
| Definition | Supports automated discovery of OAuth2 endpoints. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div) ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])) |
| Extension.id | |
| Element Id | Extension.id |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| Extension.extension | |
| Element Id | Extension.extension |
| 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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. |
| Slicing | This element introduces a set of slices. The slicing rules are:
|
| Extension.extension(authorize) | |
| Element Id | Extension.extension:authorize |
| Definition | The OAuth2 "authorize" endpoint for this FHIR server. |
| Control | 1..1 |
| Type | Extension |
| Extension.extension.id | |
| Element Id | Extension.extension:authorize.id |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| Extension.extension.extension | |
| Element Id | Extension.extension:authorize.extension |
| Definition | An Extension |
| Control | 0..0 |
| Type | Extension |
| Slicing | This element introduces a set of slices. The slicing rules are:
|
| Extension.extension.url | |
| Element Id | Extension.extension:authorize.url |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| 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. |
| Fixed Value | authorize |
| Extension.extension.valueUri | |
| Element Id | Extension.extension:authorize.valueUri |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..1 |
| Type | uri |
| Extension.extension(token) | |
| Element Id | Extension.extension:token |
| Definition | The OAuth2 "token" endpoint for this FHIR server. |
| Control | 1..1 |
| Type | Extension |
| Extension.extension.id | |
| Element Id | Extension.extension:token.id |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| Extension.extension.extension | |
| Element Id | Extension.extension:token.extension |
| Definition | An Extension |
| Control | 0..0 |
| Type | Extension |
| Slicing | This element introduces a set of slices. The slicing rules are:
|
| Extension.extension.url | |
| Element Id | Extension.extension:token.url |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| 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. |
| Fixed Value | token |
| Extension.extension.valueUri | |
| Element Id | Extension.extension:token.valueUri |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..1 |
| Type | uri |
| Extension.extension(register) | |
| Element Id | Extension.extension:register |
| Definition | The OAuth2 dynamic registration endpoint for this FHIR server, if supported. |
| Control | 0..1 |
| Type | Extension |
| Extension.extension.id | |
| Element Id | Extension.extension:register.id |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| Extension.extension.extension | |
| Element Id | Extension.extension:register.extension |
| Definition | An Extension |
| Control | 0..0 |
| Type | Extension |
| Slicing | This element introduces a set of slices. The slicing rules are:
|
| Extension.extension.url | |
| Element Id | Extension.extension:register.url |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| 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. |
| Fixed Value | register |
| Extension.extension.valueUri | |
| Element Id | Extension.extension:register.valueUri |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..1 |
| Type | uri |
| Extension.extension(manage) | |
| Element Id | Extension.extension:manage |
| Definition | The user-facing authorization management workflow entry point for this FHIR server. |
| Control | 0..1 |
| Type | Extension |
| Extension.extension.id | |
| Element Id | Extension.extension:manage.id |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| Extension.extension.extension | |
| Element Id | Extension.extension:manage.extension |
| Definition | An Extension |
| Control | 0..0 |
| Type | Extension |
| Slicing | This element introduces a set of slices. The slicing rules are:
|
| Extension.extension.url | |
| Element Id | Extension.extension:manage.url |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| 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. |
| Fixed Value | manage |
| Extension.extension.valueUri | |
| Element Id | Extension.extension:manage.valueUri |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..1 |
| Type | uri |
| Extension.url | |
| Element Id | Extension.url |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| 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. |
| Fixed Value | http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris |
| Extension.value[x] | |
| Element Id | Extension.value[x] |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..0 |
| Type | Choice of: 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, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, UsageContext, Dosage |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:12+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change