- This is an Implementation Guide for UK Core FHIR Assets in Development.
- There will be disruption as the content will be updated on an ad-hoc basis and with links not working.
- Therefore this Implementation Guide must not be implemented.
- Please follow the guidance on the "Contact Us" page if you need any assistance.
StructureDefinition-UKCore-Consent
Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Consent | draft | 2.4.0 | 2023-12-16 | This profile defines the UK constraints and extensions on the International FHIR resource Consent. |
Profile_Purpose |
---|
The purpose of this profile is to be used to express a Consent regarding Healthcare. There are four anticipated uses for the Consent Resource, all of which are written or verbal agreements by a healthcare consumer [grantor] or a personal representative, made to an authorised entity [grantee] concerning authorised or restricted actions with any limitations on purpose of use, and handling instructions to which the authorised entity SHALL comply:
|
Detailed Descriptions
Consent | |
Definition | A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. |
Cardinality | 0...* |
Comments | Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives. |
Invariants |
|
Mappings |
|
Consent.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | System.String |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Consent.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Consent.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
Consent.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. CommonLanguages (preferred) |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
Consent.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Consent.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Consent.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.identifier | |
Definition | Unique identifier for this copy of the Consent Statement. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Comments | This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same. |
Invariants |
|
Examples | General { "system": "urn:ietf:rfc:3986", "value": "Local eCMS identifier" } |
Mappings |
|
Consent.status | |
Definition | Indicates the current state of this consent. |
Cardinality | 1...1 |
Type | code |
Binding | Indicates the state of the consent. ConsentState (required) |
Must Support | True |
Modifier | True |
Summary | True |
Requirements | The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive. |
Comments | This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid. |
Invariants |
|
Mappings |
|
Consent.scope | |
Definition | A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | The four anticipated uses for the Consent Resource. ConsentScopeCodes (extensible) |
Must Support | True |
Modifier | True |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Consent.category | |
Definition | A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. |
Cardinality | 1...* |
Type | CodeableConcept |
Binding | A classification of the type of consents found in a consent statement. ConsentCategoryCodes (extensible) |
Must Support | True |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Consent.patient | |
Definition | The patient/healthcare consumer to whom this consent applies. |
Cardinality | 0...1 |
Type | Reference(Patient) |
Must Support | True |
Summary | True |
Comments | Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person. |
Invariants |
|
Mappings |
|
Consent.dateTime | |
Definition | When this Consent was issued / created / indexed. |
Cardinality | 0...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Comments | This is not the time of the original consent, but the time that this statement was made or derived. |
Invariants |
|
Mappings |
|
Consent.performer | |
Definition | Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions. |
Cardinality | 0...* |
Type | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) |
Must Support | True |
Summary | True |
Alias | consentor |
Comments | Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian. |
Invariants |
|
Mappings |
|
Consent.organization | |
Definition | The organization that manages the consent, and the framework within which it is executed. |
Cardinality | 0...* |
Type | Reference(Organization) |
Must Support | True |
Summary | True |
Alias | custodian |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Consent.source[x] | |
Definition | The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document. |
Cardinality | 0...1 |
Type | Attachment |
Must Support | True |
Summary | True |
Comments | The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id. |
Invariants |
|
Mappings |
|
Consent.policy | |
Definition | The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Consent.policy.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Consent.policy.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.policy.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
Invariants |
|
Mappings |
|
Consent.policy.authority | |
Definition | Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives. |
Cardinality | 0...1 |
Type | uri |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Consent.policy.uri | |
Definition | The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. |
Cardinality | 0...1 |
Type | uri |
Comments | This element is for discoverability / documentation and does not modify or qualify the policy rules. |
Invariants |
|
Mappings |
|
Consent.policyRule | |
Definition | A reference to the specific base computable regulation or policy. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Regulatory policy examples. ConsentPolicyRuleCodes (extensible) |
Summary | True |
Requirements | Might be a unique identifier of a policy set in XACML, or other rules engine. |
Comments | If the policyRule is absent, computable consent would need to be constructed from the elements of the Consent resource. |
Invariants |
|
Mappings |
|
Consent.verification | |
Definition | Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
Consent.verification.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Consent.verification.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.verification.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
Invariants |
|
Mappings |
|
Consent.verification.verified | |
Definition | Has the instruction been verified. |
Cardinality | 1...1 |
Type | boolean |
Summary | True |
Invariants |
|
Mappings |
|
Consent.verification.verifiedWith | |
Definition | Who verified the instruction (Patient, Relative or other Authorized Person). |
Cardinality | 0...1 |
Type | Reference(Patient | RelatedPerson) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Consent.verification.verificationDate | |
Definition | Date verification was collected. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Consent.provision | |
Definition | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. |
Cardinality | 0...1 |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
Consent.provision.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Consent.provision.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.provision.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
Invariants |
|
Mappings |
|
Consent.provision.type | |
Definition | Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules. |
Cardinality | 0...1 |
Type | code |
Binding | How a rule statement is applied, such as adding additional consent or removing consent. ConsentProvisionType (required) |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Consent.provision.period | |
Definition | The timeframe in this rule is valid. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Consent.provision.actor | |
Definition | Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Consent.provision.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. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Consent.provision.actor.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.provision.actor.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
Invariants |
|
Mappings |
|
Consent.provision.actor.role | |
Definition | How the individual is involved in the resources content that is described in the exception. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | How an actor is involved in the consent considerations. SecurityRoleType (extensible) |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Consent.provision.actor.reference | |
Definition | The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). |
Cardinality | 1...1 |
Type | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Consent.provision.action | |
Definition | Actions controlled by this Rule. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Detailed codes for the consent action. ConsentActionCodes (example) |
Summary | True |
Comments | Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'. |
Invariants |
|
Mappings |
|
Consent.provision.securityLabel | |
Definition | A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) |
Summary | True |
Comments | If the consent specifies a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict. |
Invariants |
|
Mappings |
|
Consent.provision.purpose | |
Definition | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule. |
Cardinality | 0...* |
Type | Coding |
Binding | What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. v3.PurposeOfUse (extensible) |
Summary | True |
Comments | When the purpose of use tag is on the data, access request purpose of use shall not conflict. |
Invariants |
|
Mappings |
|
Consent.provision.class | |
Definition | The class of information covered by this rule. 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. |
Cardinality | 0...* |
Type | Coding |
Binding | The class (type) of information a consent rule covers. ConsentContentClass (extensible) |
Summary | True |
Comments | Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere. |
Invariants |
|
Mappings |
|
Consent.provision.code | |
Definition | If this code is found in an instance, then the rule applies. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A code from the SNOMED Clinical Terminology UK coding system that describes a trigger for an exception to a base policy. UKCoreConsentException (preferred) |
Summary | True |
Comments | Typical use of this is a Document code with class = CDA. |
Invariants |
|
Mappings |
|
Consent.provision.dataPeriod | |
Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this rule. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement. |
Invariants |
|
Mappings |
|
Consent.provision.data | |
Definition | The resources controlled by this rule if specific resources are referenced. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
Consent.provision.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. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Consent.provision.data.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.provision.data.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
Invariants |
|
Mappings |
|
Consent.provision.data.meaning | |
Definition | How the resource reference is interpreted when testing consent restrictions. |
Cardinality | 1...1 |
Type | code |
Binding | How a resource reference is interpreted when testing consent restrictions. ConsentDataMeaning (required) |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Consent.provision.data.reference | |
Definition | A reference to a specific resource that defines which resources are covered by this consent. |
Cardinality | 1...1 |
Type | Reference(Resource) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Consent.provision.provision | |
Definition | Rules which provide exceptions to the base rule or subrules. |
Cardinality | 0...* |
Type | see (provision) |
Table View
Consent | .. | |
Consent.status | .. | |
Consent.scope | .. | |
Consent.category | .. | |
Consent.patient | .. | |
Consent.dateTime | .. | |
Consent.performer | .. | |
Consent.organization | .. | |
Consent.source[x] | .. | |
Consent.provision | .. | |
Consent.provision.code | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-Consent" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Consent" /> <version value="2.4.0" /> <name value="UKCoreConsent" /> <title value="UK Core Consent" /> <status value="draft" /> <date value="2023-12-16" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="ukcore@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Consent](https://hl7.org/fhir/R4/Consent.html)." /> <purpose value="The purpose of this profile is to be used to express a Consent regarding Healthcare. There are four anticipated uses for the Consent Resource, all of which are written or verbal agreements by a healthcare consumer [grantor] or a personal representative, made to an authorised entity [grantee] concerning authorised or restricted actions with any limitations on purpose of use, and handling instructions to which the authorised entity SHALL comply: \n- **Privacy Consent Directive**: Agreement to collect, access, use or disclose (share) information. \n- **Medical Treatment Consent Directive**: Consent to undergo a specific treatment (or record of refusal to consent). \n- **Research Consent Directive**: Consent to participate in research protocol and information sharing required. \n- **Advance Care Directives**: Consent to instructions for potentially needed medical treatment (e.g. DNR)." /> <copyright value="Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <fhirVersion value="4.0.1" /> <mapping> <identity value="workflow" /> <uri value="http://hl7.org/fhir/workflow" /> <name value="Workflow Pattern" /> </mapping> <mapping> <identity value="v2" /> <uri value="http://hl7.org/v2" /> <name value="HL7 v2 Mapping" /> </mapping> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <mapping> <identity value="w5" /> <uri value="http://hl7.org/fhir/fivews" /> <name value="FiveWs Pattern Mapping" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Consent" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Consent" /> <derivation value="constraint" /> <differential> <element id="Consent.status"> <path value="Consent.status" /> <mustSupport value="true" /> </element> <element id="Consent.scope"> <path value="Consent.scope" /> <mustSupport value="true" /> </element> <element id="Consent.category"> <path value="Consent.category" /> <mustSupport value="true" /> </element> <element id="Consent.patient"> <path value="Consent.patient" /> <mustSupport value="true" /> </element> <element id="Consent.dateTime"> <path value="Consent.dateTime" /> <mustSupport value="true" /> </element> <element id="Consent.performer"> <path value="Consent.performer" /> <mustSupport value="true" /> </element> <element id="Consent.organization"> <path value="Consent.organization" /> <mustSupport value="true" /> </element> <element id="Consent.source[x]"> <path value="Consent.source[x]" /> <mustSupport value="true" /> </element> <element id="Consent.provision.code"> <path value="Consent.provision.code" /> <binding> <strength value="preferred" /> <description value="A code from the SNOMED Clinical Terminology UK coding system that describes a trigger for an exception to a base policy." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ConsentException" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-Consent", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Consent", "version": "2.4.0", "name": "UKCoreConsent", "title": "UK Core Consent", "status": "draft", "date": "2023-12-16", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Consent](https://hl7.org/fhir/R4/Consent.html).", "purpose": "The purpose of this profile is to be used to express a Consent regarding Healthcare. There are four anticipated uses for the Consent Resource, all of which are written or verbal agreements by a healthcare consumer [grantor] or a personal representative, made to an authorised entity [grantee] concerning authorised or restricted actions with any limitations on purpose of use, and handling instructions to which the authorised entity SHALL comply: \n- **Privacy Consent Directive**: Agreement to collect, access, use or disclose (share) information. \n- **Medical Treatment Consent Directive**: Consent to undergo a specific treatment (or record of refusal to consent). \n- **Research Consent Directive**: Consent to participate in research protocol and information sharing required. \n- **Advance Care Directives**: Consent to instructions for potentially needed medical treatment (e.g. DNR).", "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" } ], "kind": "resource", "abstract": false, "type": "Consent", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Consent", "derivation": "constraint", "differential": { "element": [ { "id": "Consent.status", "path": "Consent.status", "mustSupport": true }, { "id": "Consent.scope", "path": "Consent.scope", "mustSupport": true }, { "id": "Consent.category", "path": "Consent.category", "mustSupport": true }, { "id": "Consent.patient", "path": "Consent.patient", "mustSupport": true }, { "id": "Consent.dateTime", "path": "Consent.dateTime", "mustSupport": true }, { "id": "Consent.performer", "path": "Consent.performer", "mustSupport": true }, { "id": "Consent.organization", "path": "Consent.organization", "mustSupport": true }, { "id": "Consent.source[x]", "path": "Consent.source[x]", "mustSupport": true }, { "id": "Consent.provision.code", "path": "Consent.provision.code", "binding": { "strength": "preferred", "description": "A code from the SNOMED Clinical Terminology UK coding system that describes a trigger for an exception to a base policy.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ConsentException" } } ] } }
Usage
This Profile has the following derived profiles:This Profile is referenced in the following Extensions:
This Profile is referenced in the following Profiles:
Feedback
Click here to:Examples
For Information Access - An example to illustrate a patient giving consent for information access.Example UKCore-Consent-ForInformationAccess
Example Usage Scenarios
The following are example usage scenarios for the UK Core Consent profile:
- Privacy Consent Directive: Agreement to collect, access, use or disclose (share) information.
- Medical Treatment Consent Directive: Consent to undergo a specific treatment (or record of refusal to consent).
- Research Consent Directive: Consent to participate in research protocol and information sharing required.
- Advance Care Directives: Consent to instructions for potentially needed medical treatment (e.g. DNR).
Profile Specific Implementation Guidance:
Minimum Viable Content
A minimum viable content that all provider and consumer systems SHALL support are the following elements.
Element | Reason |
---|---|
Consent.status |
Indicates the current state of this consent. |
Consent.scope |
A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. |
Consent.category |
The classification of the consent statement - for indexing/retrieval |
Consent.patient |
The patient/healthcare consumer to whom this consent applies. |
Consent.dateTime |
When this consent was issued / created / indexed. |
Consent.performer |
Who is agreeing to the policy and rules |
Consent.organization |
The custodian of the consent |
Consent.source[x] |
The source from which this consent is taken |
Bindings (differential)
More information about the bindings to UK Core ValueSets can be found below.
Context | Strength | Link |
---|---|---|
Consent.provision.code | Preferred | ValueSet UKCore-ConsentException |
performer
The resource being referenced SHALL conform to one of the following:
- Profile UKCore-Organization
- Profile UKCore-Patient
- Profile UKCore-Practitioner
- Profile UKCore-PractitionerRole
- Profile UKCore-RelatedPerson
organization
The resource being referenced SHALL conform to the following Profile UKCore-Organization.
source[x]
The source on which this consent statement is based, either as an inline Attachment, or as a reference. The resource being referenced SHALL conform to one of the following:
verification
verification.verifiedWith
The resource being referenced SHALL conform to one of the following:
provision
provision.actor.reference
The resource being referenced SHOULD conform to one of the following:
- Profile UKCore-CareTeam
- Profile UKCore-Device
- Group Resource
- Profile UKCore-Organization
- Profile UKCore-Patient
- Profile UKCore-Practitioner
- Profile UKCore-PractitionerRole
- Profile UKCore-RelatedPerson
provision.data.reference
Where a UK Core profile exists the resource being referenced SHOULD conform to the profile.
provision.code
This element has a binding to ValueSet UKCore-ConsentException.