FHIR Cross-Version Extensions package for FHIR R4B from FHIR R3 - Version 0.0.1-snapshot-2. See the Directory of published versions
| Page standards status: Informative | Maturity Level: 0 |
Definitions for the ext-R3-Consent.except extension.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. |
| Short | Additional rule - addition or removal of permissions |
| Comments |
|
| Control | 0..* |
| 2. Extension.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 4. Extension.extension:type | |
| Slice Name | type |
| Definition | Action to take - permit or deny - when the exception conditions are met. |
| Short | deny | permit |
| Comments |
|
| Control | 1..1 |
| 6. Extension.extension:type.url | |
| Control | 1..1 |
| Fixed Value | type |
| 8. Extension.extension:type.value[x] | |
| Definition | Action to take - permit or deny - when the exception conditions are met. |
| Short | deny | permit |
| Comments |
|
| Binding | The codes SHALL be taken from ConsentProvisionType (required to http://hl7.org/fhir/ValueSet/consent-provision-type|4.3.0)How an exception statement is applied, such as adding additional consent or removing consent |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. Extension.extension:period | |
| Slice Name | period |
| Definition | The timeframe in this exception is valid. |
| Short | Timeframe for this exception |
| Comments |
|
| Control | 0..1 |
| 12. Extension.extension:period.url | |
| Control | 1..1 |
| Fixed Value | period |
| 14. Extension.extension:period.value[x] | |
| Definition | The timeframe in this exception is valid. |
| Short | Timeframe for this exception |
| Comments |
|
| Type | Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 16. Extension.extension:actor | |
| Slice Name | actor |
| Definition | Who or what is controlled by this Exception. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). |
| Short | Who|what controlled by this exception (or group, by role) |
| Comments |
|
| Control | 0..* |
| 18. Extension.extension:actor.extension | |
| Control | 2..* |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 20. Extension.extension:actor.extension:role | |
| Slice Name | role |
| Definition | How the individual is involved in the resources content that is described in the exception. |
| Short | How the actor is involved |
| Comments |
|
| Control | 1..1 |
| 22. Extension.extension:actor.extension:role.url | |
| Control | 1..1 |
| Fixed Value | role |
| 24. Extension.extension:actor.extension:role.value[x] | |
| Definition | How the individual is involved in the resources content that is described in the exception. |
| Short | How the actor is involved |
| Comments |
|
| Binding | Unless not suitable, these codes SHALL be taken from R3_security_role_type_for_R4B (0.0.1-snapshot-2) (extensible to http://hl7.org/fhir/3.0/ValueSet/R3-security-role-type-for-R4B|0.0.1-snapshot-2)How an actor is involved in the consent considerations |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 26. Extension.extension:actor.extension:reference | |
| Slice Name | reference |
| Definition | The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). |
| Short | Resource for the actor (or group, by role) |
| Comments |
|
| Control | 1..1 |
| 28. Extension.extension:actor.extension:reference.url | |
| Control | 1..1 |
| Fixed Value | reference |
| 30. Extension.extension:actor.extension:reference.value[x] | |
| Definition | The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). |
| Short | Resource for the actor (or group, by role) |
| Comments |
|
| Type | Reference |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 32. Extension.extension:actor.url | |
| Control | 1..1 |
| Fixed Value | actor |
| 34. Extension.extension:action | |
| Slice Name | action |
| Definition | Actions controlled by this Exception. |
| Short | Actions controlled by this exception |
| Comments |
|
| Control | 0..* |
| 36. Extension.extension:action.url | |
| Control | 1..1 |
| Fixed Value | action |
| 38. Extension.extension:action.value[x] | |
| Definition | Actions controlled by this Exception. |
| Short | Actions controlled by this exception |
| Comments |
|
| Binding | For example codes, see R3_consent_action_for_R4B (0.0.1-snapshot-2) (example to http://hl7.org/fhir/3.0/ValueSet/R3-consent-action-for-R4B|0.0.1-snapshot-2)Detailed codes for the consent action. |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 40. Extension.extension:securityLabel | |
| Slice Name | securityLabel |
| Definition | A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels. |
| Short | Security Labels that define affected resources |
| Comments |
|
| Control | 0..* |
| 42. Extension.extension:securityLabel.url | |
| Control | 1..1 |
| Fixed Value | securityLabel |
| 44. Extension.extension:securityLabel.value[x] | |
| Definition | A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels. |
| Short | Security Labels that define affected resources |
| Comments |
|
| Binding | Unless not suitable, these codes SHALL be taken from R3_security_labels_for_R4B (0.0.1-snapshot-2) (extensible to http://hl7.org/fhir/3.0/ValueSet/R3-security-labels-for-R4B|0.0.1-snapshot-2)Security Labels from the Healthcare Privacy and Security Classification System. |
| Type | Coding |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 46. Extension.extension:purpose | |
| Slice Name | purpose |
| Definition | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception. |
| Short | Context of activities covered by this exception |
| Comments |
|
| Control | 0..* |
| 48. Extension.extension:purpose.url | |
| Control | 1..1 |
| Fixed Value | purpose |
| 50. Extension.extension:purpose.value[x] | |
| Definition | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception. |
| Short | Context of activities covered by this exception |
| Comments |
|
| Binding | Unless not suitable, these codes SHALL be taken from R3_v3_PurposeOfUse_for_R4B (0.0.1-snapshot-2) (extensible to http://hl7.org/fhir/3.0/ValueSet/R3-v3-PurposeOfUse-for-R4B|0.0.1-snapshot-2)What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels |
| Type | Coding |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 52. Extension.extension:class | |
| Slice Name | class |
| Definition | The class of information covered by this exception. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. |
| Short | e.g. Resource Type, Profile, or CDA etc |
| Comments |
|
| Control | 0..* |
| 54. Extension.extension:class.url | |
| Control | 1..1 |
| Fixed Value | class |
| 56. Extension.extension:class.value[x] | |
| Definition | The class of information covered by this exception. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. |
| Short | e.g. Resource Type, Profile, or CDA etc |
| Comments |
|
| Binding | Unless not suitable, these codes SHALL be taken from R3_consent_content_class_for_R4B (0.0.1-snapshot-2) (extensible to http://hl7.org/fhir/3.0/ValueSet/R3-consent-content-class-for-R4B|0.0.1-snapshot-2)The class (type) of information a consent rule covers |
| Type | Coding |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 58. Extension.extension:code | |
| Slice Name | code |
| Definition | If this code is found in an instance, then the exception applies. |
| Short | e.g. LOINC or SNOMED CT code, etc in the content |
| Comments |
|
| Control | 0..* |
| 60. Extension.extension:code.url | |
| Control | 1..1 |
| Fixed Value | code |
| 62. Extension.extension:code.value[x] | |
| Definition | If this code is found in an instance, then the exception applies. |
| Short | e.g. LOINC or SNOMED CT code, etc in the content |
| Comments |
|
| Binding | For example codes, see R3_consent_content_code_for_R4B (0.0.1-snapshot-2) (example to http://hl7.org/fhir/3.0/ValueSet/R3-consent-content-code-for-R4B|0.0.1-snapshot-2)If this code is found in an instance, then the exception applies |
| Type | Coding |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 64. Extension.extension:dataPeriod | |
| Slice Name | dataPeriod |
| Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this exception. |
| Short | Timeframe for data controlled by this exception |
| Comments |
|
| Control | 0..1 |
| 66. Extension.extension:dataPeriod.url | |
| Control | 1..1 |
| Fixed Value | dataPeriod |
| 68. Extension.extension:dataPeriod.value[x] | |
| Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this exception. |
| Short | Timeframe for data controlled by this exception |
| Comments |
|
| Type | Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 70. Extension.extension:data | |
| Slice Name | data |
| Definition | The resources controlled by this exception, if specific resources are referenced. |
| Short | Data controlled by this exception |
| Comments |
|
| Control | 0..* |
| 72. Extension.extension:data.extension | |
| Control | 2..* |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 74. Extension.extension:data.extension:meaning | |
| Slice Name | meaning |
| Definition | How the resource reference is interpreted when testing consent restrictions. |
| Short | instance | related | dependents | authoredby |
| Comments |
|
| Control | 1..1 |
| 76. Extension.extension:data.extension:meaning.url | |
| Control | 1..1 |
| Fixed Value | meaning |
| 78. Extension.extension:data.extension:meaning.value[x] | |
| Definition | How the resource reference is interpreted when testing consent restrictions. |
| Short | instance | related | dependents | authoredby |
| Comments |
|
| Binding | The codes SHALL be taken from ConsentDataMeaning (required to http://hl7.org/fhir/ValueSet/consent-data-meaning|4.3.0)How a resource reference is interpreted when testing consent restrictions |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 80. Extension.extension:data.extension:reference | |
| Slice Name | reference |
| Definition | A reference to a specific resource that defines which resources are covered by this consent. |
| Short | The actual data reference |
| Comments |
|
| Control | 1..1 |
| 82. Extension.extension:data.extension:reference.url | |
| Control | 1..1 |
| Fixed Value | reference |
| 84. Extension.extension:data.extension:reference.value[x] | |
| Definition | A reference to a specific resource that defines which resources are covered by this consent. |
| Short | The actual data reference |
| Comments |
|
| Type | Reference |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 86. Extension.extension:data.url | |
| Control | 1..1 |
| Fixed Value | data |
| 88. Extension.url | |
| Control | 1..1 |
| Fixed Value | http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.except |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. Optional Extension Element - found in all resources. |
| Short | Additional rule - addition or removal of permissionsOptional Extensions Element |
| Comments |
|
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 2. Extension.extension | |
| Definition | An Extension 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 | ExtensionAdditional 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 | 10..* |
| 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())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 Extension.extension. The slices areUnordered and ClosedOpen, and can be differentiated using the following discriminators: |
| 4. Extension.extension:type | |
| Slice Name | type |
| Definition | Action to take - permit or deny - when the exception conditions are met. |
| Short | deny | permitAdditional content defined by implementations |
| Comments |
|
| Control | 10..1* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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()) |
| 6. Extension.extension:type.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | type |
| 8. Extension.extension:type.value[x] | |
| Definition | Action to take - permit or deny - when the exception conditions are met. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | deny | permitValue of extension |
| Comments |
|
| Control | 0..1 |
| Binding | The codes SHALL be taken from For codes, see ConsentProvisionType (required to http://hl7.org/fhir/ValueSet/consent-provision-type|4.3.0)How an exception statement is applied, such as adding additional consent or removing consent |
| Type | code, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Extension.extension:period | |
| Slice Name | period |
| Definition | The timeframe in this exception is valid. |
| Short | Timeframe for this exceptionAdditional content defined by implementations |
| Comments |
|
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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()) |
| 12. Extension.extension:period.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | period |
| 14. Extension.extension:period.value[x] | |
| Definition | The timeframe in this exception is valid. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Timeframe for this exceptionValue of extension |
| Comments |
|
| Control | 0..1 |
| Type | Period, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Extension.extension:actor | |
| Slice Name | actor |
| Definition | Who or what is controlled by this Exception. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). |
| Short | Who|what controlled by this exception (or group, by role)Additional content defined by implementations |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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()) |
| 18. Extension.extension:actor.extension | |
| Definition | An Extension 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 | ExtensionAdditional 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 | 20..* |
| 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())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 Extension.extension.extension. The slices areUnordered and ClosedOpen, and can be differentiated using the following discriminators: |
| 20. Extension.extension:actor.extension:role | |
| Slice Name | role |
| Definition | How the individual is involved in the resources content that is described in the exception. |
| Short | How the actor is involvedAdditional content defined by implementations |
| Comments |
|
| Control | 10..1* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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()) |
| 22. Extension.extension:actor.extension:role.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | role |
| 24. Extension.extension:actor.extension:role.value[x] | |
| Definition | How the individual is involved in the resources content that is described in the exception. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | How the actor is involvedValue of extension |
| Comments |
|
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see R3_security_role_type_for_R4B (0.0.1-snapshot-2) (extensible to http://hl7.org/fhir/3.0/ValueSet/R3-security-role-type-for-R4B|0.0.1-snapshot-2)How an actor is involved in the consent considerations |
| Type | CodeableConcept, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. Extension.extension:actor.extension:reference | |
| Slice Name | reference |
| Definition | The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). |
| Short | Resource for the actor (or group, by role)Additional content defined by implementations |
| Comments |
|
| Control | 10..1* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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. Extension.extension:actor.extension:reference.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | reference |
| 30. Extension.extension:actor.extension:reference.value[x] | |
| Definition | The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Resource for the actor (or group, by role)Value of extension |
| Comments |
|
| Control | 0..1 |
| Type | Reference, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. Extension.extension:actor.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | actor |
| 34. Extension.extension:action | |
| Slice Name | action |
| Definition | Actions controlled by this Exception. |
| Short | Actions controlled by this exceptionAdditional content defined by implementations |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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()) |
| 36. Extension.extension:action.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | action |
| 38. Extension.extension:action.value[x] | |
| Definition | Actions controlled by this Exception. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Actions controlled by this exceptionValue of extension |
| Comments |
|
| Control | 0..1 |
| Binding | For example codes, see For codes, see R3_consent_action_for_R4B (0.0.1-snapshot-2) (example to http://hl7.org/fhir/3.0/ValueSet/R3-consent-action-for-R4B|0.0.1-snapshot-2)Detailed codes for the consent action. |
| Type | CodeableConcept, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 40. Extension.extension:securityLabel | |
| Slice Name | securityLabel |
| Definition | A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels. |
| Short | Security Labels that define affected resourcesAdditional content defined by implementations |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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()) |
| 42. Extension.extension:securityLabel.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | securityLabel |
| 44. Extension.extension:securityLabel.value[x] | |
| Definition | A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Security Labels that define affected resourcesValue of extension |
| Comments |
|
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see R3_security_labels_for_R4B (0.0.1-snapshot-2) (extensible to http://hl7.org/fhir/3.0/ValueSet/R3-security-labels-for-R4B|0.0.1-snapshot-2)Security Labels from the Healthcare Privacy and Security Classification System. |
| Type | Coding, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. Extension.extension:purpose | |
| Slice Name | purpose |
| Definition | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception. |
| Short | Context of activities covered by this exceptionAdditional content defined by implementations |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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()) |
| 48. Extension.extension:purpose.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | purpose |
| 50. Extension.extension:purpose.value[x] | |
| Definition | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Context of activities covered by this exceptionValue of extension |
| Comments |
|
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see R3_v3_PurposeOfUse_for_R4B (0.0.1-snapshot-2) (extensible to http://hl7.org/fhir/3.0/ValueSet/R3-v3-PurposeOfUse-for-R4B|0.0.1-snapshot-2)What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels |
| Type | Coding, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 52. Extension.extension:class | |
| Slice Name | class |
| Definition | The class of information covered by this exception. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. |
| Short | e.g. Resource Type, Profile, or CDA etcAdditional content defined by implementations |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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. Extension.extension:class.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | class |
| 56. Extension.extension:class.value[x] | |
| Definition | The class of information covered by this exception. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | e.g. Resource Type, Profile, or CDA etcValue of extension |
| Comments |
|
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see R3_consent_content_class_for_R4B (0.0.1-snapshot-2) (extensible to http://hl7.org/fhir/3.0/ValueSet/R3-consent-content-class-for-R4B|0.0.1-snapshot-2)The class (type) of information a consent rule covers |
| Type | Coding, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. Extension.extension:code | |
| Slice Name | code |
| Definition | If this code is found in an instance, then the exception applies. |
| Short | e.g. LOINC or SNOMED CT code, etc in the contentAdditional content defined by implementations |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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()) |
| 60. Extension.extension:code.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | code |
| 62. Extension.extension:code.value[x] | |
| Definition | If this code is found in an instance, then the exception applies. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | e.g. LOINC or SNOMED CT code, etc in the contentValue of extension |
| Comments |
|
| Control | 0..1 |
| Binding | For example codes, see For codes, see R3_consent_content_code_for_R4B (0.0.1-snapshot-2) (example to http://hl7.org/fhir/3.0/ValueSet/R3-consent-content-code-for-R4B|0.0.1-snapshot-2)If this code is found in an instance, then the exception applies |
| Type | Coding, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 64. Extension.extension:dataPeriod | |
| Slice Name | dataPeriod |
| Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this exception. |
| Short | Timeframe for data controlled by this exceptionAdditional content defined by implementations |
| Comments |
|
| Control | 0..1* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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. Extension.extension:dataPeriod.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | dataPeriod |
| 68. Extension.extension:dataPeriod.value[x] | |
| Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this exception. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Timeframe for data controlled by this exceptionValue of extension |
| Comments |
|
| Control | 0..1 |
| Type | Period, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 70. Extension.extension:data | |
| Slice Name | data |
| Definition | The resources controlled by this exception, if specific resources are referenced. |
| Short | Data controlled by this exceptionAdditional content defined by implementations |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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. Extension.extension:data.extension | |
| Definition | An Extension 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 | ExtensionAdditional 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 | 20..* |
| 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())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 Extension.extension.extension. The slices areUnordered and ClosedOpen, and can be differentiated using the following discriminators: |
| 74. Extension.extension:data.extension:meaning | |
| Slice Name | meaning |
| Definition | How the resource reference is interpreted when testing consent restrictions. |
| Short | instance | related | dependents | authoredbyAdditional content defined by implementations |
| Comments |
|
| Control | 10..1* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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()) |
| 76. Extension.extension:data.extension:meaning.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | meaning |
| 78. Extension.extension:data.extension:meaning.value[x] | |
| Definition | How the resource reference is interpreted when testing consent restrictions. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | instance | related | dependents | authoredbyValue of extension |
| Comments |
|
| Control | 0..1 |
| Binding | The codes SHALL be taken from For codes, see ConsentDataMeaning (required to http://hl7.org/fhir/ValueSet/consent-data-meaning|4.3.0)How a resource reference is interpreted when testing consent restrictions |
| Type | code, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. Extension.extension:data.extension:reference | |
| Slice Name | reference |
| Definition | A reference to a specific resource that defines which resources are covered by this consent. |
| Short | The actual data referenceAdditional content defined by implementations |
| Comments |
|
| Control | 10..1* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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())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()) |
| 82. Extension.extension:data.extension:reference.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | reference |
| 84. Extension.extension:data.extension:reference.value[x] | |
| Definition | A reference to a specific resource that defines which resources are covered by this consent. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | The actual data referenceValue of extension |
| Comments |
|
| Control | 0..1 |
| Type | Reference, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 86. Extension.extension:data.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | data |
| 88. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.except |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. |
| Short | Additional rule - addition or removal of permissions |
| Comments |
|
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 2. Extension.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 4. Extension.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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 Extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 6. Extension.extension:type | |
| Slice Name | type |
| Definition | Action to take - permit or deny - when the exception conditions are met. |
| Short | deny | permit |
| Comments |
|
| Control | 1..1 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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()) |
| 8. Extension.extension:type.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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 10. Extension.extension:type.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Extension.extension:type.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | type |
| 14. Extension.extension:type.value[x] | |
| Definition | Action to take - permit or deny - when the exception conditions are met. |
| Short | deny | permit |
| Comments |
|
| Control | 0..1 |
| Binding | The codes SHALL be taken from ConsentProvisionType (required to http://hl7.org/fhir/ValueSet/consent-provision-type|4.3.0)How an exception statement is applied, such as adding additional consent or removing consent |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Extension.extension:period | |
| Slice Name | period |
| Definition | The timeframe in this exception is valid. |
| Short | Timeframe for this exception |
| Comments |
|
| Control | 0..1 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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()) |
| 18. Extension.extension:period.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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 20. Extension.extension:period.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. Extension.extension:period.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | period |
| 24. Extension.extension:period.value[x] | |
| Definition | The timeframe in this exception is valid. |
| Short | Timeframe for this exception |
| Comments |
|
| Control | 0..1 |
| Type | Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. Extension.extension:actor | |
| Slice Name | actor |
| Definition | Who or what is controlled by this Exception. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). |
| Short | Who|what controlled by this exception (or group, by role) |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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. Extension.extension: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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 30. Extension.extension:actor.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 2..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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 Extension.extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 32. Extension.extension:actor.extension:role | |
| Slice Name | role |
| Definition | How the individual is involved in the resources content that is described in the exception. |
| Short | How the actor is involved |
| Comments |
|
| Control | 1..1 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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. Extension.extension:actor.extension:role.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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 36. Extension.extension:actor.extension:role.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 Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 38. Extension.extension:actor.extension:role.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | role |
| 40. Extension.extension:actor.extension:role.value[x] | |
| Definition | How the individual is involved in the resources content that is described in the exception. |
| Short | How the actor is involved |
| Comments |
|
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from R3_security_role_type_for_R4B (0.0.1-snapshot-2) (extensible to http://hl7.org/fhir/3.0/ValueSet/R3-security-role-type-for-R4B|0.0.1-snapshot-2)How an actor is involved in the consent considerations |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. Extension.extension:actor.extension:reference | |
| Slice Name | reference |
| Definition | The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). |
| Short | Resource for the actor (or group, by role) |
| Comments |
|
| Control | 1..1 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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. Extension.extension:actor.extension:reference.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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 46. Extension.extension:actor.extension:reference.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 Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 48. Extension.extension:actor.extension:reference.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | reference |
| 50. Extension.extension:actor.extension:reference.value[x] | |
| Definition | The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). |
| Short | Resource for the actor (or group, by role) |
| Comments |
|
| Control | 0..1 |
| Type | Reference |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 52. Extension.extension:actor.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | actor |
| 54. Extension.extension:actor.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 0..1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 56. Extension.extension:action | |
| Slice Name | action |
| Definition | Actions controlled by this Exception. |
| Short | Actions controlled by this exception |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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()) |
| 58. Extension.extension:action.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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 60. Extension.extension:action.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 62. Extension.extension:action.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | action |
| 64. Extension.extension:action.value[x] | |
| Definition | Actions controlled by this Exception. |
| Short | Actions controlled by this exception |
| Comments |
|
| Control | 0..1 |
| Binding | For example codes, see R3_consent_action_for_R4B (0.0.1-snapshot-2) (example to http://hl7.org/fhir/3.0/ValueSet/R3-consent-action-for-R4B|0.0.1-snapshot-2)Detailed codes for the consent action. |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. Extension.extension:securityLabel | |
| Slice Name | securityLabel |
| Definition | A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels. |
| Short | Security Labels that define affected resources |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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()) |
| 68. Extension.extension:securityLabel.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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 70. Extension.extension:securityLabel.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 72. Extension.extension:securityLabel.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | securityLabel |
| 74. Extension.extension:securityLabel.value[x] | |
| Definition | A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels. |
| Short | Security Labels that define affected resources |
| Comments |
|
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from R3_security_labels_for_R4B (0.0.1-snapshot-2) (extensible to http://hl7.org/fhir/3.0/ValueSet/R3-security-labels-for-R4B|0.0.1-snapshot-2)Security Labels from the Healthcare Privacy and Security Classification System. |
| Type | Coding |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 76. Extension.extension:purpose | |
| Slice Name | purpose |
| Definition | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception. |
| Short | Context of activities covered by this exception |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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()) |
| 78. Extension.extension:purpose.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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 80. Extension.extension:purpose.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 82. Extension.extension:purpose.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | purpose |
| 84. Extension.extension:purpose.value[x] | |
| Definition | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception. |
| Short | Context of activities covered by this exception |
| Comments |
|
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from R3_v3_PurposeOfUse_for_R4B (0.0.1-snapshot-2) (extensible to http://hl7.org/fhir/3.0/ValueSet/R3-v3-PurposeOfUse-for-R4B|0.0.1-snapshot-2)What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels |
| Type | Coding |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 86. Extension.extension:class | |
| Slice Name | class |
| Definition | The class of information covered by this exception. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. |
| Short | e.g. Resource Type, Profile, or CDA etc |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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. Extension.extension:class.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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 90. Extension.extension:class.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 92. Extension.extension:class.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | class |
| 94. Extension.extension:class.value[x] | |
| Definition | The class of information covered by this exception. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. |
| Short | e.g. Resource Type, Profile, or CDA etc |
| Comments |
|
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from R3_consent_content_class_for_R4B (0.0.1-snapshot-2) (extensible to http://hl7.org/fhir/3.0/ValueSet/R3-consent-content-class-for-R4B|0.0.1-snapshot-2)The class (type) of information a consent rule covers |
| Type | Coding |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 96. Extension.extension:code | |
| Slice Name | code |
| Definition | If this code is found in an instance, then the exception applies. |
| Short | e.g. LOINC or SNOMED CT code, etc in the content |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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()) |
| 98. Extension.extension:code.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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 100. Extension.extension:code.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 102. Extension.extension:code.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | code |
| 104. Extension.extension:code.value[x] | |
| Definition | If this code is found in an instance, then the exception applies. |
| Short | e.g. LOINC or SNOMED CT code, etc in the content |
| Comments |
|
| Control | 0..1 |
| Binding | For example codes, see R3_consent_content_code_for_R4B (0.0.1-snapshot-2) (example to http://hl7.org/fhir/3.0/ValueSet/R3-consent-content-code-for-R4B|0.0.1-snapshot-2)If this code is found in an instance, then the exception applies |
| Type | Coding |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 106. Extension.extension:dataPeriod | |
| Slice Name | dataPeriod |
| Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this exception. |
| Short | Timeframe for data controlled by this exception |
| Comments |
|
| Control | 0..1 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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()) |
| 108. Extension.extension:dataPeriod.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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 110. Extension.extension:dataPeriod.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 112. Extension.extension:dataPeriod.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | dataPeriod |
| 114. Extension.extension:dataPeriod.value[x] | |
| Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this exception. |
| Short | Timeframe for data controlled by this exception |
| Comments |
|
| Control | 0..1 |
| Type | Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 116. Extension.extension:data | |
| Slice Name | data |
| Definition | The resources controlled by this exception, if specific resources are referenced. |
| Short | Data controlled by this exception |
| Comments |
|
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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()) |
| 118. Extension.extension:data.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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 120. Extension.extension:data.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 2..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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 Extension.extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 122. Extension.extension:data.extension:meaning | |
| Slice Name | meaning |
| Definition | How the resource reference is interpreted when testing consent restrictions. |
| Short | instance | related | dependents | authoredby |
| Comments |
|
| Control | 1..1 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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()) |
| 124. Extension.extension:data.extension:meaning.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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 126. Extension.extension:data.extension:meaning.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 Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 128. Extension.extension:data.extension:meaning.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | meaning |
| 130. Extension.extension:data.extension:meaning.value[x] | |
| Definition | How the resource reference is interpreted when testing consent restrictions. |
| Short | instance | related | dependents | authoredby |
| Comments |
|
| Control | 0..1 |
| Binding | The codes SHALL be taken from ConsentDataMeaning (required to http://hl7.org/fhir/ValueSet/consent-data-meaning|4.3.0)How a resource reference is interpreted when testing consent restrictions |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 132. Extension.extension:data.extension:reference | |
| Slice Name | reference |
| Definition | A reference to a specific resource that defines which resources are covered by this consent. |
| Short | The actual data reference |
| Comments |
|
| Control | 1..1 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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()) |
| 134. Extension.extension:data.extension:reference.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 | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 136. Extension.extension:data.extension:reference.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 Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 138. Extension.extension:data.extension:reference.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | reference |
| 140. Extension.extension:data.extension:reference.value[x] | |
| Definition | A reference to a specific resource that defines which resources are covered by this consent. |
| Short | The actual data reference |
| Comments |
|
| Control | 0..1 |
| Type | Reference |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 142. Extension.extension:data.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | data |
| 144. Extension.extension:data.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 0..1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 146. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.except |
| 148. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 0..1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |