Shared Health Specification and Guide Version 5.0

 

Definitions for the ext-practitioner-saml Extension

1. Extension
Definition

The SAML token used to confirm the identity of the practitioner

Control0..1
Comments

none

2. Extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
3. Extension.extension
Definition

An Extension

Control0..0
TypeExtension
4. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Must Supporttrue
Comments

Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/ext-practitioner-saml

Fixed Valuehttp://sharedhealth.exchange/fhir/StructureDefinition/ext-practitioner-saml
5. Extension.value[x]
Definition

The SAML token used to confirm the identity of the practitioner

Control1..1
TypeAttachment
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Comments

none

SlicingThis element introduces a set of slices on Extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
6. Extension.value[x]:valueAttachment
SliceNamevalueAttachment
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).

Control0..1
TypeAttachment
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
7. Extension.value[x]:valueAttachment.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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 Length0
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.

Control1..1
BindingThe codes SHALL be taken from MimeTypes The mime type of an attachment. Any valid mime type is allowed.
Typecode
Must Supporttrue
Requirements

Processors of the data need to be able to know how to interpret the data.

Comments

Fixed value: application/xml

Max Length0
Fixed Valueapplication/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.

Control0..1
BindingThe codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language.
Typecode
Requirements

Users need to be able to choose between the languages in a set of attachments.

Max Length0
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.

Control1..1
Typebase64Binary
Must Supporttrue
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 Length0
12. Extension.value[x]:valueAttachment.url
Definition

An alternative location where the data can be accessed.

Control0..1
Typeuri
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 Length0
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.

Control0..1
TypeunsignedInt
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 Length0
14. Extension.value[x]:valueAttachment.hash
Definition

The calculated hash of the data using SHA-1. Represented using base64.

Control0..1
Typebase64Binary
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 Length0
15. Extension.value[x]:valueAttachment.title
Definition

A label or set of text to display in place of the data.

Control0..1
Typestring
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 Length0
Example
General:Official Corporate Logo
16. Extension.value[x]:valueAttachment.creation
Definition

The date that the attachment was first created.

Control0..1
TypedateTime
Requirements

This is often tracked as an integrity issue for use of the attachment.

Max Length0