StructureDefinition-UKCore-Consent

Canonical_URLCurrent_VersionLast_UpdatedDescription
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Consent2.3.02023-04-28

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:

  • 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).

Snapshot View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
scopeΣ ?!1..1CodeableConceptBinding
categoryΣ1..*CodeableConceptBinding
patientΣ I0..1Reference(UK Core Patient)
dateTimeΣ0..1dateTime
performerΣ I0..*Reference(UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson)
organizationΣ I0..*Reference(UK Core Organization)
sourceAttachmentAttachment
sourceReferenceReference(DocumentReference | Contract | UK Core QuestionnaireResponse | UK Core Consent)
authorityI0..1uri
uriI0..1uri
policyRuleΣ I0..1CodeableConceptBinding
verifiedΣ1..1boolean
verifiedWithI0..1Reference(UK Core Patient | UK Core RelatedPerson)
verificationDate0..1dateTime
typeΣ0..1codeBinding
periodΣ I0..1Period
role1..1CodeableConceptBinding
referenceI1..1Reference(Device | Group | CareTeam | UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson)
actionΣ0..*CodeableConcept
securityLabelΣ0..*CodingBinding
purposeΣ0..*CodingBinding
classΣ0..*CodingBinding
codeΣ0..*CodeableConcept
dataPeriodΣ I0..1Period
meaningΣ1..1codeBinding
referenceΣ I1..1Reference(Resource)
provision0..*see (provision)

Differential View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
scopeΣ ?!1..1CodeableConceptBinding
categoryΣ1..*CodeableConceptBinding
patientΣ I0..1Reference(UK Core Patient)
dateTimeΣ0..1dateTime
performerΣ I0..*Reference(UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson)
organizationΣ I0..*Reference(UK Core Organization)
sourceAttachmentAttachment
sourceReferenceReference(DocumentReference | Contract | UK Core QuestionnaireResponse | UK Core Consent)
authorityI0..1uri
uriI0..1uri
policyRuleΣ I0..1CodeableConceptBinding
verifiedΣ1..1boolean
verifiedWithI0..1Reference(UK Core Patient | UK Core RelatedPerson)
verificationDate0..1dateTime
typeΣ0..1codeBinding
periodΣ I0..1Period
role1..1CodeableConceptBinding
referenceI1..1Reference(Device | Group | CareTeam | UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson)
actionΣ0..*CodeableConcept
securityLabelΣ0..*CodingBinding
purposeΣ0..*CodingBinding
classΣ0..*CodingBinding
codeΣ0..*CodeableConcept
dataPeriodΣ I0..1Period
meaningΣ1..1codeBinding
referenceΣ I1..1Reference(Resource)
provision0..*see (provision)

Hybrid View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
scopeΣ ?!1..1CodeableConceptBinding
categoryΣ1..*CodeableConceptBinding
patientΣ I0..1Reference(UK Core Patient)
dateTimeΣ0..1dateTime
performerΣ I0..*Reference(UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson)
organizationΣ I0..*Reference(UK Core Organization)
sourceAttachmentAttachment
sourceReferenceReference(DocumentReference | Contract | UK Core QuestionnaireResponse | UK Core Consent)
authorityI0..1uri
uriI0..1uri
policyRuleΣ I0..1CodeableConceptBinding
verifiedΣ1..1boolean
verifiedWithI0..1Reference(UK Core Patient | UK Core RelatedPerson)
verificationDate0..1dateTime
typeΣ0..1codeBinding
periodΣ I0..1Period
role1..1CodeableConceptBinding
referenceI1..1Reference(Device | Group | CareTeam | UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson)
actionΣ0..*CodeableConcept
securityLabelΣ0..*CodingBinding
purposeΣ0..*CodingBinding
classΣ0..*CodingBinding
codeΣ0..*CodeableConcept
dataPeriodΣ I0..1Period
meaningΣ1..1codeBinding
referenceΣ I1..1Reference(Resource)
provision0..*see (provision)

Table View

Consent..
Consent.identifier..
Consent.identifier.assignerReference(UK Core Organization)..
Consent.patientReference(UK Core Patient)..
Consent.performerReference(UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson)..
Consent.organizationReference(UK Core Organization)..
Consent.source[x]Attachment, Reference(DocumentReference | Contract | UK Core QuestionnaireResponse | UK Core Consent)..
Consent.verification..
Consent.verification.verifiedWithReference(UK Core Patient | UK Core RelatedPerson)..
Consent.provision..
Consent.provision.actor..
Consent.provision.actor.referenceReference(Device | Group | CareTeam | UK Core Organization | UK Core Patient | UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson)..


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.3.0" />
    <name value="UKCoreConsent" />
    <title value="UK Core Consent" />
    <status value="active" />
    <date value="2023-04-28" />
    <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 &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); 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 &quot;AS IS&quot; 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&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; 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.identifier.assigner">
            <path value="Consent.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Consent.patient">
            <path value="Consent.patient" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
            </type>
        </element>
        <element id="Consent.performer">
            <path value="Consent.performer" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
            </type>
        </element>
        <element id="Consent.organization">
            <path value="Consent.organization" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Consent.source[x]">
            <path value="Consent.source[x]" />
            <type>
                <code value="Attachment" />
            </type>
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/DocumentReference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Contract" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Consent" />
            </type>
        </element>
        <element id="Consent.verification.verifiedWith">
            <path value="Consent.verification.verifiedWith" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
            </type>
        </element>
        <element id="Consent.provision.actor.reference">
            <path value="Consent.provision.actor.reference" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Consent",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Consent",
    "version": "2.3.0",
    "name": "UKCoreConsent",
    "title": "UK Core Consent",
    "status": "active",
    "date": "2023-04-28",
    "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.identifier.assigner",
                "path": "Consent.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Consent.patient",
                "path": "Consent.patient",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
                        ]
                    }
                ]
            },
            {
                "id": "Consent.performer",
                "path": "Consent.performer",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson"
                        ]
                    }
                ]
            },
            {
                "id": "Consent.organization",
                "path": "Consent.organization",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Consent.source[x]",
                "path": "Consent.source[x]",
                "type":  [
                    {
                        "code": "Attachment"
                    },
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/DocumentReference",
                            "http://hl7.org/fhir/StructureDefinition/Contract",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Consent"
                        ]
                    }
                ]
            },
            {
                "id": "Consent.verification.verifiedWith",
                "path": "Consent.verification.verifiedWith",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson"
                        ]
                    }
                ]
            },
            {
                "id": "Consent.provision.actor.reference",
                "path": "Consent.provision.actor.reference",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Device",
                            "http://hl7.org/fhir/StructureDefinition/Group",
                            "http://hl7.org/fhir/StructureDefinition/CareTeam",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson"
                        ]
                    }
                ]
            }
        ]
    }
}

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

patient

The resource being referenced SHALL conform to the following Profile UKCore-Patient.


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 SHALL conform to one of the following:

provision.data.reference

Where a UK Core profile exists the resource being referenced SHALL conform to the profile.


back to top