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
| Draft as of 2026-03-06 |
Definitions for the PermissionTicket logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. PermissionTicket | |
| Definition | Common core of a Permission Ticket. Includes the security envelope, shared authorization claims, and a typed details slot. Business-specific semantics are defined by ticket-type-specific schemas selected by ticket_type. |
| 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 (Trusted Issuer URL) |
| Short | Issuer (Trusted Issuer 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 | Issuer-defined subject of the authorization grant (profile-specific). This value is issuer-local and SHALL NOT be relied on as a cross-party client identifier. |
| Short | Issuer-defined subject of the authorization grant (profile-specific). This value is issuer-local and SHALL NOT be relied on as a cross-party client identifier. |
| 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 (recipient URL(s) or network / trust framework identifier) |
| Short | Audience (recipient URL(s) or network / trust framework identifier) |
| Control | 1..* |
| Type | uri |
| 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 | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. PermissionTicket.iat | |
| Definition | Issued-At Timestamp |
| Short | Issued-At Timestamp |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. 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 |
| 14. PermissionTicket.ticket-type | |
| Definition | Ticket type URI identifying the ticket schema and processing rules |
| Short | Ticket type URI identifying the ticket schema and processing rules |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. PermissionTicket.cnf | |
| Definition | Confirmation (RFC 7800). RECOMMENDED. Required by some ticket types (e.g., patient access, authorized representative, research). When present, Data Holders SHALL enforce key binding. |
| Short | Confirmation (RFC 7800). RECOMMENDED. Required by some ticket types (e.g., patient access, authorized representative, research). When present, Data Holders SHALL enforce key binding. |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. PermissionTicket.cnf.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 |
| 20. PermissionTicket.cnf.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.cnf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. PermissionTicket.cnf.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()) |
| 24. PermissionTicket.cnf.jkt | |
| Definition | JWK Thumbprint (RFC 7638) of the authorized client key |
| Short | JWK Thumbprint (RFC 7638) of the authorized client key |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. PermissionTicket.revocation | |
| Definition | Revocation Information |
| Short | Revocation Information |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. PermissionTicket.revocation.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 |
| 30. PermissionTicket.revocation.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.revocation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 32. PermissionTicket.revocation.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()) |
| 34. PermissionTicket.revocation.url | |
| Definition | URL of the Credential Revocation List (CRL) |
| Short | URL of the Credential Revocation List (CRL) |
| Control | 1..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. PermissionTicket.revocation.rid | |
| Definition | Revocation Identifier (opaque, max 24 chars) |
| Short | Revocation Identifier (opaque, max 24 chars) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. PermissionTicket.authorization | |
| Definition | Common Authorization Claims |
| Short | Common Authorization Claims |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 40. PermissionTicket.authorization.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 |
| 42. PermissionTicket.authorization.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.authorization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 44. PermissionTicket.authorization.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()) |
| 46. PermissionTicket.authorization.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())) |
| 48. PermissionTicket.authorization.subject.id | |
| Definition | Local resource ID (type=reference) Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Local resource ID (type=reference)Unique 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 |
| 50. PermissionTicket.authorization.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.authorization.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 52. PermissionTicket.authorization.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()) |
| 54. PermissionTicket.authorization.subject.type | |
| Definition | Subject resolution mode: match | identifier | reference |
| Short | Subject resolution mode: match | identifier | reference |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 56. PermissionTicket.authorization.subject.traits | |
| Definition | Demographic traits for matching (type=match) |
| Short | Demographic traits for matching (type=match) |
| Control | 0..1 |
| Type | Patient |
| 58. PermissionTicket.authorization.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 |
| 60. PermissionTicket.authorization.subject.reference | |
| Definition | Local resource reference, e.g. Patient/123 (type=reference) |
| Short | Local resource reference, e.g. Patient/123 (type=reference) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 62. PermissionTicket.authorization.subject.identifier | |
| Definition | Business Identifier (type=identifier) |
| Short | Business Identifier (type=identifier) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 64. PermissionTicket.authorization.access | |
| Definition | Access Constraints |
| Short | Access Constraints |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. PermissionTicket.authorization.access.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 |
| 68. PermissionTicket.authorization.access.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.authorization.access.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 70. PermissionTicket.authorization.access.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()) |
| 72. PermissionTicket.authorization.access.scopes | |
| Definition | SMART Scopes (e.g. patient/Immunization.rs) |
| Short | SMART Scopes (e.g. patient/Immunization.rs) |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 74. PermissionTicket.authorization.access.periods | |
| Definition | Time restrictions (Service Date) |
| Short | Time restrictions (Service Date) |
| Control | 0..* |
| Type | Period |
| 76. PermissionTicket.authorization.access.jurisdictions | |
| Definition | Jurisdictional restrictions (state/country granularity) |
| Short | Jurisdictional restrictions (state/country granularity) |
| Control | 0..* |
| Type | Address |
| 78. PermissionTicket.authorization.access.organizations | |
| Definition | Source organization restrictions (matching by identifier preferred) |
| Short | Source organization restrictions (matching by identifier preferred) |
| Control | 0..* |
| Type | Organization |
| 80. PermissionTicket.authorization.requester | |
| Definition | The Requesting Agent (optional) |
| Short | The Requesting Agent (optional) |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. PermissionTicket.authorization.requester.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 |
| 84. PermissionTicket.authorization.requester.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.authorization.requester.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 86. PermissionTicket.authorization.requester.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()) |
| 88. PermissionTicket.authorization.requester.resourceType | |
| Definition | Type of requester (Practitioner, PractitionerRole, RelatedPerson, Organization) |
| Short | Type of requester (Practitioner, PractitionerRole, RelatedPerson, Organization) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 90. PermissionTicket.authorization.requester.name | |
| Definition | Name of the requester |
| Short | Name of the requester |
| Control | 0..* |
| Type | HumanName |
| 92. PermissionTicket.authorization.requester.telecom | |
| Definition | Contact details |
| Short | Contact details |
| Control | 0..* |
| Type | ContactPoint |
| 94. PermissionTicket.authorization.requester.identifier | |
| Definition | Requester identifiers (NPI, etc) |
| Short | Requester identifiers (NPI, etc) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 96. PermissionTicket.authorization.requester.relationship | |
| Definition | Relationship to subject |
| Short | Relationship to subject |
| Control | 0..* |
| Type | CodeableConcept |
| 98. PermissionTicket.authorization.requester.type | |
| Definition | Organization type |
| Short | Organization type |
| Control | 0..* |
| Type | CodeableConcept |
| 100. PermissionTicket.authorization.requester.contained | |
| Definition | Embedded resources |
| Short | Embedded resources |
| Control | 0..* |
| Type | Resource |
| 102. PermissionTicket.details | |
| Definition | Ticket-type-specific claims. Schema is defined by the ticket_type URI. Absent when the ticket type has no business-specific fields beyond the common authorization claims. |
| Short | Ticket-type-specific claims. Schema is defined by the ticket_type URI. Absent when the ticket type has no business-specific fields beyond the common authorization claims. |
| Control | 0..1 |
| Type | BackboneElement |
Guidance on how to interpret the contents of this table can be foundhere
| 0. PermissionTicket | |
| Definition | Common core of a Permission Ticket. Includes the security envelope, shared authorization claims, and a typed details slot. Business-specific semantics are defined by ticket-type-specific schemas selected by ticket_type. |
| 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 (Trusted Issuer URL) |
| Short | Issuer (Trusted Issuer 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 | Issuer-defined subject of the authorization grant (profile-specific). This value is issuer-local and SHALL NOT be relied on as a cross-party client identifier. |
| Short | Issuer-defined subject of the authorization grant (profile-specific). This value is issuer-local and SHALL NOT be relied on as a cross-party client identifier. |
| 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 (recipient URL(s) or network / trust framework identifier) |
| Short | Audience (recipient URL(s) or network / trust framework identifier) |
| Control | 1..* |
| Type | uri |
| 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 | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. PermissionTicket.iat | |
| Definition | Issued-At Timestamp |
| Short | Issued-At Timestamp |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. 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 |
| 14. PermissionTicket.ticket-type | |
| Definition | Ticket type URI identifying the ticket schema and processing rules |
| Short | Ticket type URI identifying the ticket schema and processing rules |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. PermissionTicket.cnf | |
| Definition | Confirmation (RFC 7800). RECOMMENDED. Required by some ticket types (e.g., patient access, authorized representative, research). When present, Data Holders SHALL enforce key binding. |
| Short | Confirmation (RFC 7800). RECOMMENDED. Required by some ticket types (e.g., patient access, authorized representative, research). When present, Data Holders SHALL enforce key binding. |
| Control | 0..1 |
| Type | BackboneElement |
| 18. PermissionTicket.cnf.jkt | |
| Definition | JWK Thumbprint (RFC 7638) of the authorized client key |
| Short | JWK Thumbprint (RFC 7638) of the authorized client key |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. PermissionTicket.revocation | |
| Definition | Revocation Information |
| Short | Revocation Information |
| Control | 0..1 |
| Type | BackboneElement |
| 22. PermissionTicket.revocation.url | |
| Definition | URL of the Credential Revocation List (CRL) |
| Short | URL of the Credential Revocation List (CRL) |
| Control | 1..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. PermissionTicket.revocation.rid | |
| Definition | Revocation Identifier (opaque, max 24 chars) |
| Short | Revocation Identifier (opaque, max 24 chars) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. PermissionTicket.authorization | |
| Definition | Common Authorization Claims |
| Short | Common Authorization Claims |
| Control | 1..1 |
| Type | BackboneElement |
| 28. PermissionTicket.authorization.subject | |
| Definition | The Patient or Subject of the data |
| Short | The Patient or Subject of the data |
| Control | 1..1 |
| Type | BackboneElement |
| 30. PermissionTicket.authorization.subject.type | |
| Definition | Subject resolution mode: match | identifier | reference |
| Short | Subject resolution mode: match | identifier | reference |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. PermissionTicket.authorization.subject.traits | |
| Definition | Demographic traits for matching (type=match) |
| Short | Demographic traits for matching (type=match) |
| Control | 0..1 |
| Type | Patient |
| 34. PermissionTicket.authorization.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 |
| 36. PermissionTicket.authorization.subject.id | |
| Definition | Local resource ID (type=reference) |
| Short | Local resource ID (type=reference) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. PermissionTicket.authorization.subject.reference | |
| Definition | Local resource reference, e.g. Patient/123 (type=reference) |
| Short | Local resource reference, e.g. Patient/123 (type=reference) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. PermissionTicket.authorization.subject.identifier | |
| Definition | Business Identifier (type=identifier) |
| Short | Business Identifier (type=identifier) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 42. PermissionTicket.authorization.access | |
| Definition | Access Constraints |
| Short | Access Constraints |
| Control | 1..1 |
| Type | BackboneElement |
| 44. PermissionTicket.authorization.access.scopes | |
| Definition | SMART Scopes (e.g. patient/Immunization.rs) |
| Short | SMART Scopes (e.g. patient/Immunization.rs) |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 46. PermissionTicket.authorization.access.periods | |
| Definition | Time restrictions (Service Date) |
| Short | Time restrictions (Service Date) |
| Control | 0..* |
| Type | Period |
| 48. PermissionTicket.authorization.access.jurisdictions | |
| Definition | Jurisdictional restrictions (state/country granularity) |
| Short | Jurisdictional restrictions (state/country granularity) |
| Control | 0..* |
| Type | Address |
| 50. PermissionTicket.authorization.access.organizations | |
| Definition | Source organization restrictions (matching by identifier preferred) |
| Short | Source organization restrictions (matching by identifier preferred) |
| Control | 0..* |
| Type | Organization |
| 52. PermissionTicket.authorization.requester | |
| Definition | The Requesting Agent (optional) |
| Short | The Requesting Agent (optional) |
| Control | 0..1 |
| Type | BackboneElement |
| 54. PermissionTicket.authorization.requester.resourceType | |
| Definition | Type of requester (Practitioner, PractitionerRole, RelatedPerson, Organization) |
| Short | Type of requester (Practitioner, PractitionerRole, RelatedPerson, Organization) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 56. PermissionTicket.authorization.requester.name | |
| Definition | Name of the requester |
| Short | Name of the requester |
| Control | 0..* |
| Type | HumanName |
| 58. PermissionTicket.authorization.requester.telecom | |
| Definition | Contact details |
| Short | Contact details |
| Control | 0..* |
| Type | ContactPoint |
| 60. PermissionTicket.authorization.requester.identifier | |
| Definition | Requester identifiers (NPI, etc) |
| Short | Requester identifiers (NPI, etc) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 62. PermissionTicket.authorization.requester.relationship | |
| Definition | Relationship to subject |
| Short | Relationship to subject |
| Control | 0..* |
| Type | CodeableConcept |
| 64. PermissionTicket.authorization.requester.type | |
| Definition | Organization type |
| Short | Organization type |
| Control | 0..* |
| Type | CodeableConcept |
| 66. PermissionTicket.authorization.requester.contained | |
| Definition | Embedded resources |
| Short | Embedded resources |
| Control | 0..* |
| Type | Resource |
| 68. PermissionTicket.details | |
| Definition | Ticket-type-specific claims. Schema is defined by the ticket_type URI. Absent when the ticket type has no business-specific fields beyond the common authorization claims. |
| Short | Ticket-type-specific claims. Schema is defined by the ticket_type URI. Absent when the ticket type has no business-specific fields beyond the common authorization claims. |
| Control | 0..1 |
| Type | BackboneElement |
Guidance on how to interpret the contents of this table can be foundhere
| 0. PermissionTicket | |
| Definition | Common core of a Permission Ticket. Includes the security envelope, shared authorization claims, and a typed details slot. Business-specific semantics are defined by ticket-type-specific schemas selected by ticket_type. |
| 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 (Trusted Issuer URL) |
| Short | Issuer (Trusted Issuer 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 | Issuer-defined subject of the authorization grant (profile-specific). This value is issuer-local and SHALL NOT be relied on as a cross-party client identifier. |
| Short | Issuer-defined subject of the authorization grant (profile-specific). This value is issuer-local and SHALL NOT be relied on as a cross-party client identifier. |
| 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 (recipient URL(s) or network / trust framework identifier) |
| Short | Audience (recipient URL(s) or network / trust framework identifier) |
| Control | 1..* |
| Type | uri |
| 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 | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. PermissionTicket.iat | |
| Definition | Issued-At Timestamp |
| Short | Issued-At Timestamp |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. 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 |
| 14. PermissionTicket.ticket-type | |
| Definition | Ticket type URI identifying the ticket schema and processing rules |
| Short | Ticket type URI identifying the ticket schema and processing rules |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. PermissionTicket.cnf | |
| Definition | Confirmation (RFC 7800). RECOMMENDED. Required by some ticket types (e.g., patient access, authorized representative, research). When present, Data Holders SHALL enforce key binding. |
| Short | Confirmation (RFC 7800). RECOMMENDED. Required by some ticket types (e.g., patient access, authorized representative, research). When present, Data Holders SHALL enforce key binding. |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. PermissionTicket.cnf.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 |
| 20. PermissionTicket.cnf.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.cnf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. PermissionTicket.cnf.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()) |
| 24. PermissionTicket.cnf.jkt | |
| Definition | JWK Thumbprint (RFC 7638) of the authorized client key |
| Short | JWK Thumbprint (RFC 7638) of the authorized client key |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. PermissionTicket.revocation | |
| Definition | Revocation Information |
| Short | Revocation Information |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. PermissionTicket.revocation.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 |
| 30. PermissionTicket.revocation.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.revocation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 32. PermissionTicket.revocation.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()) |
| 34. PermissionTicket.revocation.url | |
| Definition | URL of the Credential Revocation List (CRL) |
| Short | URL of the Credential Revocation List (CRL) |
| Control | 1..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. PermissionTicket.revocation.rid | |
| Definition | Revocation Identifier (opaque, max 24 chars) |
| Short | Revocation Identifier (opaque, max 24 chars) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. PermissionTicket.authorization | |
| Definition | Common Authorization Claims |
| Short | Common Authorization Claims |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 40. PermissionTicket.authorization.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 |
| 42. PermissionTicket.authorization.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.authorization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 44. PermissionTicket.authorization.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()) |
| 46. PermissionTicket.authorization.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())) |
| 48. PermissionTicket.authorization.subject.id | |
| Definition | Local resource ID (type=reference) |
| Short | Local resource ID (type=reference) |
| 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 |
| 50. PermissionTicket.authorization.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.authorization.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 52. PermissionTicket.authorization.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()) |
| 54. PermissionTicket.authorization.subject.type | |
| Definition | Subject resolution mode: match | identifier | reference |
| Short | Subject resolution mode: match | identifier | reference |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 56. PermissionTicket.authorization.subject.traits | |
| Definition | Demographic traits for matching (type=match) |
| Short | Demographic traits for matching (type=match) |
| Control | 0..1 |
| Type | Patient |
| 58. PermissionTicket.authorization.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 |
| 60. PermissionTicket.authorization.subject.reference | |
| Definition | Local resource reference, e.g. Patient/123 (type=reference) |
| Short | Local resource reference, e.g. Patient/123 (type=reference) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 62. PermissionTicket.authorization.subject.identifier | |
| Definition | Business Identifier (type=identifier) |
| Short | Business Identifier (type=identifier) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 64. PermissionTicket.authorization.access | |
| Definition | Access Constraints |
| Short | Access Constraints |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. PermissionTicket.authorization.access.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 |
| 68. PermissionTicket.authorization.access.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.authorization.access.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 70. PermissionTicket.authorization.access.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()) |
| 72. PermissionTicket.authorization.access.scopes | |
| Definition | SMART Scopes (e.g. patient/Immunization.rs) |
| Short | SMART Scopes (e.g. patient/Immunization.rs) |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 74. PermissionTicket.authorization.access.periods | |
| Definition | Time restrictions (Service Date) |
| Short | Time restrictions (Service Date) |
| Control | 0..* |
| Type | Period |
| 76. PermissionTicket.authorization.access.jurisdictions | |
| Definition | Jurisdictional restrictions (state/country granularity) |
| Short | Jurisdictional restrictions (state/country granularity) |
| Control | 0..* |
| Type | Address |
| 78. PermissionTicket.authorization.access.organizations | |
| Definition | Source organization restrictions (matching by identifier preferred) |
| Short | Source organization restrictions (matching by identifier preferred) |
| Control | 0..* |
| Type | Organization |
| 80. PermissionTicket.authorization.requester | |
| Definition | The Requesting Agent (optional) |
| Short | The Requesting Agent (optional) |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. PermissionTicket.authorization.requester.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 |
| 84. PermissionTicket.authorization.requester.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.authorization.requester.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 86. PermissionTicket.authorization.requester.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()) |
| 88. PermissionTicket.authorization.requester.resourceType | |
| Definition | Type of requester (Practitioner, PractitionerRole, RelatedPerson, Organization) |
| Short | Type of requester (Practitioner, PractitionerRole, RelatedPerson, Organization) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 90. PermissionTicket.authorization.requester.name | |
| Definition | Name of the requester |
| Short | Name of the requester |
| Control | 0..* |
| Type | HumanName |
| 92. PermissionTicket.authorization.requester.telecom | |
| Definition | Contact details |
| Short | Contact details |
| Control | 0..* |
| Type | ContactPoint |
| 94. PermissionTicket.authorization.requester.identifier | |
| Definition | Requester identifiers (NPI, etc) |
| Short | Requester identifiers (NPI, etc) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 96. PermissionTicket.authorization.requester.relationship | |
| Definition | Relationship to subject |
| Short | Relationship to subject |
| Control | 0..* |
| Type | CodeableConcept |
| 98. PermissionTicket.authorization.requester.type | |
| Definition | Organization type |
| Short | Organization type |
| Control | 0..* |
| Type | CodeableConcept |
| 100. PermissionTicket.authorization.requester.contained | |
| Definition | Embedded resources |
| Short | Embedded resources |
| Control | 0..* |
| Type | Resource |
| 102. PermissionTicket.details | |
| Definition | Ticket-type-specific claims. Schema is defined by the ticket_type URI. Absent when the ticket type has no business-specific fields beyond the common authorization claims. |
| Short | Ticket-type-specific claims. Schema is defined by the ticket_type URI. Absent when the ticket type has no business-specific fields beyond the common authorization claims. |
| Control | 0..1 |
| Type | BackboneElement |