SMART Permission Tickets
0.1.0 - ci-build

SMART Permission Tickets, published by . This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jmandel/smart-permission-tickets-wip/ and changes regularly. See the Directory of published versions

## Logical Model: PermissionTicket - Detailed Descriptions

Draft as of 2025-11-20

Definitions for the PermissionTicket logical model.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. PermissionTicket
Definition | The full payload of a Permission Ticket, including standard JWT claims and the custom permission object.
Short | Permission Ticket (JWT Payload)
Control | 0..*
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. PermissionTicket.iss
Definition | Issuer (Trust Broker URL)
Short | Issuer (Trust Broker URL)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
4. PermissionTicket.sub
Definition | Subject (Client ID)
Short | Subject (Client ID)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
6. PermissionTicket.aud
Definition | Audience (Network/Data Holder)
Short | Audience (Network/Data Holder)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
8. PermissionTicket.exp
Definition | Expiration Timestamp
Short | Expiration Timestamp
Control | 0..1
Type | integer
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
10. PermissionTicket.jti
Definition | Unique Ticket ID
Short | Unique Ticket ID
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
12. PermissionTicket.ticket-context
Definition | Permission Details
Short | Permission Details
Control | 1..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. PermissionTicket.ticket-context.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
16. PermissionTicket.ticket-context.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `PermissionTicket.ticket_context.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
18. PermissionTicket.ticket-context.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. PermissionTicket.ticket-context.subject
Definition | The Patient or Subject of the data
Short | The Patient or Subject of the data
Control | 1..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. PermissionTicket.ticket-context.subject.id
Definition | Resource ID Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Resource IDUnique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
24. PermissionTicket.ticket-context.subject.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `PermissionTicket.ticket_context.subject.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
26. PermissionTicket.ticket-context.subject.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. PermissionTicket.ticket-context.subject.type
Definition | Type of subject match (e.g., 'match' or 'reference')
Short | Type of subject match (e.g., 'match' or 'reference')
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
30. PermissionTicket.ticket-context.subject.traits
Definition | Demographic traits for matching
Short | Demographic traits for matching
Control | 0..1
Type | Patient
32. PermissionTicket.ticket-context.subject.resourceType
Definition | Resource Type (e.g. Patient)
Short | Resource Type (e.g. Patient)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
34. PermissionTicket.ticket-context.subject.identifier
Definition | Business Identifier
Short | Business Identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
36. PermissionTicket.ticket-context.actor
Definition | The Requesting Agent
Short | The Requesting Agent
Control | 0..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. PermissionTicket.ticket-context.actor.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
40. PermissionTicket.ticket-context.actor.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `PermissionTicket.ticket_context.actor.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
42. PermissionTicket.ticket-context.actor.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
44. PermissionTicket.ticket-context.actor.resourceType
Definition | Type of actor (PractitionerRole, RelatedPerson, Organization)
Short | Type of actor (PractitionerRole, RelatedPerson, Organization)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
46. PermissionTicket.ticket-context.actor.name
Definition | Name of the actor
Short | Name of the actor
Control | 0..*
Type | HumanName
48. PermissionTicket.ticket-context.actor.telecom
Definition | Contact details
Short | Contact details
Control | 0..*
Type | ContactPoint
50. PermissionTicket.ticket-context.actor.identifier
Definition | Actor identifiers (NPI, etc)
Short | Actor identifiers (NPI, etc)
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
52. PermissionTicket.ticket-context.actor.relationship
Definition | Relationship to subject
Short | Relationship to subject
Control | 0..*
Type | CodeableConcept
54. PermissionTicket.ticket-context.actor.type
Definition | Organization type
Short | Organization type
Control | 0..*
Type | CodeableConcept
56. PermissionTicket.ticket-context.actor.contained
Definition | Embedded resources
Short | Embedded resources
Control | 0..*
Type | Resource
58. PermissionTicket.ticket-context.context
Definition | The Trigger Event
Short | The Trigger Event
Control | 0..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. PermissionTicket.ticket-context.context.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
62. PermissionTicket.ticket-context.context.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `PermissionTicket.ticket_context.context.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
64. PermissionTicket.ticket-context.context.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
66. PermissionTicket.ticket-context.context.type
Definition | Type of context (e.g. ActReason)
Short | Type of context (e.g. ActReason)
Control | 1..1
Type | Coding
68. PermissionTicket.ticket-context.context.focus
Definition | Clinical Focus (e.g. Condition)
Short | Clinical Focus (e.g. Condition)
Control | 0..1
Type | Coding
70. PermissionTicket.ticket-context.context.identifier
Definition | Issuer-specific identifiers (Case ID, etc)
Short | Issuer-specific identifiers (Case ID, etc)
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
72. PermissionTicket.ticket-context.capability
Definition | Access Capabilities
Short | Access Capabilities
Control | 1..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. PermissionTicket.ticket-context.capability.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
76. PermissionTicket.ticket-context.capability.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `PermissionTicket.ticket_context.capability.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
78. PermissionTicket.ticket-context.capability.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
80. PermissionTicket.ticket-context.capability.scopes
Definition | SMART Scopes (e.g. patient/Immunization.read)
Short | SMART Scopes (e.g. patient/Immunization.read)
Control | 0..*
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
82. PermissionTicket.ticket-context.capability.periods
Definition | Time restrictions (Service Date)
Short | Time restrictions (Service Date)
Control | 0..*
Type | Period
84. PermissionTicket.ticket-context.capability.locations
Definition | Allowed Locations (Jurisdictions)
Short | Allowed Locations (Jurisdictions)
Control | 0..*
Type | Address
86. PermissionTicket.ticket-context.capability.organizations
Definition | Allowed Organizations
Short | Allowed Organizations
Control | 0..*
Type | Organization

Guidance on how to interpret the contents of this table can be foundhere

0. PermissionTicket
Definition | The full payload of a Permission Ticket, including standard JWT claims and the custom permission object.
Short | Permission Ticket (JWT Payload)
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. PermissionTicket.iss
Definition | Issuer (Trust Broker URL)
Short | Issuer (Trust Broker URL)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
4. PermissionTicket.sub
Definition | Subject (Client ID)
Short | Subject (Client ID)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
6. PermissionTicket.aud
Definition | Audience (Network/Data Holder)
Short | Audience (Network/Data Holder)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
8. PermissionTicket.exp
Definition | Expiration Timestamp
Short | Expiration Timestamp
Control | 0..1
Type | integer
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
10. PermissionTicket.jti
Definition | Unique Ticket ID
Short | Unique Ticket ID
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
12. PermissionTicket.ticket-context
Definition | Permission Details
Short | Permission Details
Control | 1..1
Type | BackboneElement
14. PermissionTicket.ticket-context.subject
Definition | The Patient or Subject of the data
Short | The Patient or Subject of the data
Control | 1..1
Type | BackboneElement
16. PermissionTicket.ticket-context.subject.type
Definition | Type of subject match (e.g., 'match' or 'reference')
Short | Type of subject match (e.g., 'match' or 'reference')
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
18. PermissionTicket.ticket-context.subject.traits
Definition | Demographic traits for matching
Short | Demographic traits for matching
Control | 0..1
Type | Patient
20. PermissionTicket.ticket-context.subject.resourceType
Definition | Resource Type (e.g. Patient)
Short | Resource Type (e.g. Patient)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
22. PermissionTicket.ticket-context.subject.id
Definition | Resource ID
Short | Resource ID
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
24. PermissionTicket.ticket-context.subject.identifier
Definition | Business Identifier
Short | Business Identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
26. PermissionTicket.ticket-context.actor
Definition | The Requesting Agent
Short | The Requesting Agent
Control | 0..1
Type | BackboneElement
28. PermissionTicket.ticket-context.actor.resourceType
Definition | Type of actor (PractitionerRole, RelatedPerson, Organization)
Short | Type of actor (PractitionerRole, RelatedPerson, Organization)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
30. PermissionTicket.ticket-context.actor.name
Definition | Name of the actor
Short | Name of the actor
Control | 0..*
Type | HumanName
32. PermissionTicket.ticket-context.actor.telecom
Definition | Contact details
Short | Contact details
Control | 0..*
Type | ContactPoint
34. PermissionTicket.ticket-context.actor.identifier
Definition | Actor identifiers (NPI, etc)
Short | Actor identifiers (NPI, etc)
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
36. PermissionTicket.ticket-context.actor.relationship
Definition | Relationship to subject
Short | Relationship to subject
Control | 0..*
Type | CodeableConcept
38. PermissionTicket.ticket-context.actor.type
Definition | Organization type
Short | Organization type
Control | 0..*
Type | CodeableConcept
40. PermissionTicket.ticket-context.actor.contained
Definition | Embedded resources
Short | Embedded resources
Control | 0..*
Type | Resource
42. PermissionTicket.ticket-context.context
Definition | The Trigger Event
Short | The Trigger Event
Control | 0..1
Type | BackboneElement
44. PermissionTicket.ticket-context.context.type
Definition | Type of context (e.g. ActReason)
Short | Type of context (e.g. ActReason)
Control | 1..1
Type | Coding
46. PermissionTicket.ticket-context.context.focus
Definition | Clinical Focus (e.g. Condition)
Short | Clinical Focus (e.g. Condition)
Control | 0..1
Type | Coding
48. PermissionTicket.ticket-context.context.identifier
Definition | Issuer-specific identifiers (Case ID, etc)
Short | Issuer-specific identifiers (Case ID, etc)
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
50. PermissionTicket.ticket-context.capability
Definition | Access Capabilities
Short | Access Capabilities
Control | 1..1
Type | BackboneElement
52. PermissionTicket.ticket-context.capability.scopes
Definition | SMART Scopes (e.g. patient/Immunization.read)
Short | SMART Scopes (e.g. patient/Immunization.read)
Control | 0..*
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
54. PermissionTicket.ticket-context.capability.periods
Definition | Time restrictions (Service Date)
Short | Time restrictions (Service Date)
Control | 0..*
Type | Period
56. PermissionTicket.ticket-context.capability.locations
Definition | Allowed Locations (Jurisdictions)
Short | Allowed Locations (Jurisdictions)
Control | 0..*
Type | Address
58. PermissionTicket.ticket-context.capability.organizations
Definition | Allowed Organizations
Short | Allowed Organizations
Control | 0..*
Type | Organization

Guidance on how to interpret the contents of this table can be foundhere

0. PermissionTicket
Definition | The full payload of a Permission Ticket, including standard JWT claims and the custom permission object.
Short | Permission Ticket (JWT Payload)
Control | 0..*
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. PermissionTicket.iss
Definition | Issuer (Trust Broker URL)
Short | Issuer (Trust Broker URL)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
4. PermissionTicket.sub
Definition | Subject (Client ID)
Short | Subject (Client ID)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
6. PermissionTicket.aud
Definition | Audience (Network/Data Holder)
Short | Audience (Network/Data Holder)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
8. PermissionTicket.exp
Definition | Expiration Timestamp
Short | Expiration Timestamp
Control | 0..1
Type | integer
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
10. PermissionTicket.jti
Definition | Unique Ticket ID
Short | Unique Ticket ID
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
12. PermissionTicket.ticket-context
Definition | Permission Details
Short | Permission Details
Control | 1..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. PermissionTicket.ticket-context.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
16. PermissionTicket.ticket-context.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PermissionTicket.ticket_context.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
18. PermissionTicket.ticket-context.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
20. PermissionTicket.ticket-context.subject
Definition | The Patient or Subject of the data
Short | The Patient or Subject of the data
Control | 1..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. PermissionTicket.ticket-context.subject.id
Definition | Resource ID
Short | Resource ID
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
24. PermissionTicket.ticket-context.subject.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PermissionTicket.ticket_context.subject.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
26. PermissionTicket.ticket-context.subject.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
28. PermissionTicket.ticket-context.subject.type
Definition | Type of subject match (e.g., 'match' or 'reference')
Short | Type of subject match (e.g., 'match' or 'reference')
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
30. PermissionTicket.ticket-context.subject.traits
Definition | Demographic traits for matching
Short | Demographic traits for matching
Control | 0..1
Type | Patient
32. PermissionTicket.ticket-context.subject.resourceType
Definition | Resource Type (e.g. Patient)
Short | Resource Type (e.g. Patient)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
34. PermissionTicket.ticket-context.subject.identifier
Definition | Business Identifier
Short | Business Identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
36. PermissionTicket.ticket-context.actor
Definition | The Requesting Agent
Short | The Requesting Agent
Control | 0..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. PermissionTicket.ticket-context.actor.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
40. PermissionTicket.ticket-context.actor.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PermissionTicket.ticket_context.actor.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
42. PermissionTicket.ticket-context.actor.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
44. PermissionTicket.ticket-context.actor.resourceType
Definition | Type of actor (PractitionerRole, RelatedPerson, Organization)
Short | Type of actor (PractitionerRole, RelatedPerson, Organization)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
46. PermissionTicket.ticket-context.actor.name
Definition | Name of the actor
Short | Name of the actor
Control | 0..*
Type | HumanName
48. PermissionTicket.ticket-context.actor.telecom
Definition | Contact details
Short | Contact details
Control | 0..*
Type | ContactPoint
50. PermissionTicket.ticket-context.actor.identifier
Definition | Actor identifiers (NPI, etc)
Short | Actor identifiers (NPI, etc)
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
52. PermissionTicket.ticket-context.actor.relationship
Definition | Relationship to subject
Short | Relationship to subject
Control | 0..*
Type | CodeableConcept
54. PermissionTicket.ticket-context.actor.type
Definition | Organization type
Short | Organization type
Control | 0..*
Type | CodeableConcept
56. PermissionTicket.ticket-context.actor.contained
Definition | Embedded resources
Short | Embedded resources
Control | 0..*
Type | Resource
58. PermissionTicket.ticket-context.context
Definition | The Trigger Event
Short | The Trigger Event
Control | 0..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. PermissionTicket.ticket-context.context.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
62. PermissionTicket.ticket-context.context.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PermissionTicket.ticket_context.context.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
64. PermissionTicket.ticket-context.context.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
66. PermissionTicket.ticket-context.context.type
Definition | Type of context (e.g. ActReason)
Short | Type of context (e.g. ActReason)
Control | 1..1
Type | Coding
68. PermissionTicket.ticket-context.context.focus
Definition | Clinical Focus (e.g. Condition)
Short | Clinical Focus (e.g. Condition)
Control | 0..1
Type | Coding
70. PermissionTicket.ticket-context.context.identifier
Definition | Issuer-specific identifiers (Case ID, etc)
Short | Issuer-specific identifiers (Case ID, etc)
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
72. PermissionTicket.ticket-context.capability
Definition | Access Capabilities
Short | Access Capabilities
Control | 1..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. PermissionTicket.ticket-context.capability.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
76. PermissionTicket.ticket-context.capability.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.
Short | Additional content defined by implementations
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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PermissionTicket.ticket_context.capability.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
78. PermissionTicket.ticket-context.capability.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
80. PermissionTicket.ticket-context.capability.scopes
Definition | SMART Scopes (e.g. patient/Immunization.read)
Short | SMART Scopes (e.g. patient/Immunization.read)
Control | 0..*
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
82. PermissionTicket.ticket-context.capability.periods
Definition | Time restrictions (Service Date)
Short | Time restrictions (Service Date)
Control | 0..*
Type | Period
84. PermissionTicket.ticket-context.capability.locations
Definition | Allowed Locations (Jurisdictions)
Short | Allowed Locations (Jurisdictions)
Control | 0..*
Type | Address
86. PermissionTicket.ticket-context.capability.organizations
Definition | Allowed Organizations
Short | Allowed Organizations
Control | 0..*
Type | Organization