3.11.6 Extension: Practitioner SAML Token - Detailed Descriptions
Definitions for the ext-practitioner-saml Extension
1. Extension | |
Definition | The SAML token used to confirm the identity of the practitioner |
Control | 0..1 |
Comments | none |
2. Extension.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
3. Extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
4. Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Must Support | true |
Comments | Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/ext-practitioner-saml |
Fixed Value | http://sharedhealth.exchange/fhir/StructureDefinition/ext-practitioner-saml |
5. Extension.value[x] | |
Definition | The SAML token used to confirm the identity of the practitioner |
Control | 1..1 |
Type | Attachment |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Comments | none |
Slicing | This element introduces a set of slices on Extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
6. Extension.value[x]:valueAttachment | |
SliceName | valueAttachment |
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 | Attachment |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
7. Extension.value[x]:valueAttachment.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
8. Extension.value[x]:valueAttachment.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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. |
Max Length | 0 |
9. Extension.value[x]:valueAttachment.contentType | |
Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. |
Control | 1..1 |
Binding | The codes SHALL be taken from MimeTypes The mime type of an attachment. Any valid mime type is allowed. |
Type | code |
Must Support | true |
Requirements | Processors of the data need to be able to know how to interpret the data. |
Comments | Fixed value: application/xml |
Max Length | 0 |
Fixed Value | application/xml |
Example | General:text/plain; charset=UTF-8, image/png |
10. Extension.value[x]:valueAttachment.language | |
Definition | The human language of the content. The value can be any valid value according to BCP 47. |
Control | 0..1 |
Binding | The codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language. |
Type | code |
Requirements | Users need to be able to choose between the languages in a set of attachments. |
Max Length | 0 |
Example | General:en-AU |
11. Extension.value[x]:valueAttachment.data | |
Definition | The actual data of the attachment - a sequence of bytes. In XML, represented using base64. |
Control | 1..1 |
Type | base64Binary |
Must Support | true |
Requirements | The data needs to able to be transmitted inline. |
Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. |
Max Length | 0 |
12. Extension.value[x]:valueAttachment.url | |
Definition | An alternative location where the data can be accessed. |
Control | 0..1 |
Type | uri |
Requirements | The data needs to be transmitted by reference. |
Comments | If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data. |
Max Length | 0 |
Example | General:http://www.acme.com/logo-small.png |
13. Extension.value[x]:valueAttachment.size | |
Definition | The number of bytes of data that make up this attachment. |
Control | 0..1 |
Type | unsignedInt |
Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. |
Comments | The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. |
Max Length | 0 |
14. Extension.value[x]:valueAttachment.hash | |
Definition | The calculated hash of the data using SHA-1. Represented using base64. |
Control | 0..1 |
Type | base64Binary |
Requirements | Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature. |
Max Length | 0 |
15. Extension.value[x]:valueAttachment.title | |
Definition | A label or set of text to display in place of the data. |
Control | 0..1 |
Type | string |
Requirements | Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. |
Max Length | 0 |
Example | General:Official Corporate Logo |
16. Extension.value[x]:valueAttachment.creation | |
Definition | The date that the attachment was first created. |
Control | 0..1 |
Type | dateTime |
Requirements | This is often tracked as an integrity issue for use of the attachment. |
Max Length | 0 |