Extensions for Using Data Elements from FHIR R4 in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4 in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4_Consent_R3

Official URL: http://hl7.org/fhir/4.0/StructureDefinition/profile-Consent Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4_Consent_R3

This cross-version profile allows R4 Consent content to be represented via FHIR STU3 Consent resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* Consent A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:verification 0..* (Complex) R4: Consent Verified by patient or family (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.verification
.... extension:reference 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Resource for the actor (or group, by role)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:scope ?! 1..1 CodeableConcept R4: Which of the four areas this resource covers (extensible) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.scope
Binding: R4ConsentScopeForR3 (0.1.0) (extensible): The four anticipated uses for the Consent Resource.
... patient Σ 1..1 Reference(Patient) Who the consent applies to

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Consent If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ppc-1 error Consent Either a Policy or PolicyRule policy.exists() or policyRule.exists()

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* Consent A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:verification 0..* (Complex) R4: Consent Verified by patient or family (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.verification
.... extension:reference 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Resource for the actor (or group, by role)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:scope 1..1 CodeableConcept R4: Which of the four areas this resource covers (extensible) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.scope
Binding: R4ConsentScopeForR3 (0.1.0) (extensible): The four anticipated uses for the Consent Resource.
... consentingParty
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:performer 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Who is agreeing to the policy and rules
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:policyRule 0..1 CodeableConcept R4: Regulation that this consents to additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.policyRule
Binding: R4ConsentPolicyForR3 (0.1.0) (extensible): Regulatory policy examples.
... except
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:provision 0..* (Complex) R4: Nested Exception Rules (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.provision
.... code
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 0..* CodeableConcept R4: e.g. LOINC or SNOMED CT code, etc. in the content additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.provision.code

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* Consent A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:verification 0..* (Complex) R4: Consent Verified by patient or family (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.verification
.... extension:reference 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Resource for the actor (or group, by role)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:scope ?! 1..1 CodeableConcept R4: Which of the four areas this resource covers (extensible) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.scope
Binding: R4ConsentScopeForR3 (0.1.0) (extensible): The four anticipated uses for the Consent Resource.
... identifier Σ 0..1 Identifier Identifier for this record (external references)
Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!Σ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent
... category Σ 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement
... patient Σ 1..1 Reference(Patient) Who the consent applies to
... period Σ 0..1 Period Period that this consent applies
... dateTime Σ 0..1 dateTime When this Consent was created or indexed
... consentingParty Σ 0..* Reference(Organization | Patient | Practitioner | RelatedPerson) Who is agreeing to the policy and exceptions
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:performer 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Who is agreeing to the policy and rules
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... actor Σ 0..* BackboneElement Who|what controlled by this consent (or group, by role)
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType . (extensible): How an actor is involved in the consent considerations
.... reference 1..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson) Resource for the actor (or group, by role)
... action Σ 0..* CodeableConcept Actions controlled by this consent
Binding: Consent Action Codes (example): Detailed codes for the consent action.
... organization Σ 0..* Reference(Organization) Custodian of the consent
... source[x] Σ 0..1 Source from which this consent is taken
.... sourceAttachment Attachment
.... sourceIdentifier Identifier
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy 0..* BackboneElement Policies covered by this consent
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... authority C 0..1 uri Enforcement source for policy
.... uri C 0..1 uri Specific policy covered by this consent
... policyRule ΣC 0..1 uri Policy that this consents to
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:policyRule 0..1 CodeableConcept R4: Regulation that this consents to additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.policyRule
Binding: R4ConsentPolicyForR3 (0.1.0) (extensible): Regulatory policy examples.
.... value 0..1 uri Primitive value for uri
... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: All Security Labels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... purpose Σ 0..* Coding ​Context of activities for which the agreement is made
Binding: PurposeOfUse|2014-03-26 (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels
... dataPeriod Σ 0..1 Period Timeframe for data controlled by this consent
... data Σ 0..* BackboneElement Data controlled by this consent
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... meaning Σ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions
.... reference Σ 1..1 Reference(Resource) The actual data reference
... except Σ 0..* BackboneElement Additional rule - addition or removal of permissions
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:provision 0..* (Complex) R4: Nested Exception Rules (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.provision
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... type Σ 1..1 code deny | permit
Binding: ConsentExceptType (required): How an exception statement is applied, such as adding additional consent or removing consent
.... period Σ 0..1 Period Timeframe for this exception
.... actor Σ 0..* BackboneElement Who|what controlled by this exception (or group, by role)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType . (extensible): How an actor is involved in the consent considerations
..... reference 1..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson) Resource for the actor (or group, by role)
.... action Σ 0..* CodeableConcept Actions controlled by this exception
Binding: Consent Action Codes (example): Detailed codes for the consent action.
.... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: All Security Labels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose Σ 0..* Coding ​Context of activities covered by this exception
Binding: PurposeOfUse|2014-03-26 (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels
.... class Σ 0..* Coding e.g. Resource Type, Profile, or CDA etc
Binding: Consent Content Class (extensible): The class (type) of information a consent rule covers
.... code Σ 0..* Coding e.g. LOINC or SNOMED CT code, etc in the content
Binding: Consent Content Codes (example): If this code is found in an instance, then the exception applies
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 0..* CodeableConcept R4: e.g. LOINC or SNOMED CT code, etc. in the content additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.provision.code
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... dataPeriod Σ 0..1 Period Timeframe for data controlled by this exception
.... data Σ 0..* BackboneElement Data controlled by this exception
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... meaning Σ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions
..... reference Σ 1..1 Reference(Resource) The actual data reference

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Consent.status Base required ConsentState 📍3.0.2 FHIR Std.
Consent.category Base example Consent Category Codes 📍3.0.2 FHIR Std.
Consent.actor.role Base extensible SecurityRoleType . 📍1.8.0 tx.fhir.org
Consent.action Base example Consent Action Codes 📍3.0.2 FHIR Std.
Consent.securityLabel Base extensible All Security Labels . 📍3.0.2 tx.fhir.org
Consent.purpose Base extensible PurposeOfUse . 📍2014-03-26 tx.fhir.org
Consent.data.meaning Base required ConsentDataMeaning 📍3.0.2 FHIR Std.
Consent.except.type Base required ConsentExceptType 📍3.0.2 FHIR Std.
Consent.except.actor.​role Base extensible SecurityRoleType . 📍1.8.0 tx.fhir.org
Consent.except.action Base example Consent Action Codes 📍3.0.2 FHIR Std.
Consent.except.securityLabel Base extensible All Security Labels . 📍3.0.2 tx.fhir.org
Consent.except.purpose Base extensible PurposeOfUse . 📍2014-03-26 tx.fhir.org
Consent.except.class Base extensible Consent Content Class 📍3.0.2 FHIR Std.
Consent.except.code Base example Consent Content Codes 📍3.0.2 FHIR Std.
Consent.except.data.​meaning Base required ConsentDataMeaning 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Consent If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ppc-1 error Consent Either a Policy or PolicyRule policy.exists() or policyRule.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* Consent A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:verification 0..* (Complex) R4: Consent Verified by patient or family (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.verification
.... extension:reference 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Resource for the actor (or group, by role)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:scope ?! 1..1 CodeableConcept R4: Which of the four areas this resource covers (extensible) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.scope
Binding: R4ConsentScopeForR3 (0.1.0) (extensible): The four anticipated uses for the Consent Resource.
... patient Σ 1..1 Reference(Patient) Who the consent applies to

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Consent If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ppc-1 error Consent Either a Policy or PolicyRule policy.exists() or policyRule.exists()

Differential View

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* Consent A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:verification 0..* (Complex) R4: Consent Verified by patient or family (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.verification
.... extension:reference 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Resource for the actor (or group, by role)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:scope 1..1 CodeableConcept R4: Which of the four areas this resource covers (extensible) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.scope
Binding: R4ConsentScopeForR3 (0.1.0) (extensible): The four anticipated uses for the Consent Resource.
... consentingParty
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:performer 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Who is agreeing to the policy and rules
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:policyRule 0..1 CodeableConcept R4: Regulation that this consents to additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.policyRule
Binding: R4ConsentPolicyForR3 (0.1.0) (extensible): Regulatory policy examples.
... except
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:provision 0..* (Complex) R4: Nested Exception Rules (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.provision
.... code
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 0..* CodeableConcept R4: e.g. LOINC or SNOMED CT code, etc. in the content additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.provision.code

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* Consent A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:verification 0..* (Complex) R4: Consent Verified by patient or family (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.verification
.... extension:reference 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Resource for the actor (or group, by role)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:scope ?! 1..1 CodeableConcept R4: Which of the four areas this resource covers (extensible) (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.scope
Binding: R4ConsentScopeForR3 (0.1.0) (extensible): The four anticipated uses for the Consent Resource.
... identifier Σ 0..1 Identifier Identifier for this record (external references)
Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!Σ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent
... category Σ 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: Consent Category Codes (example): A classification of the type of consents found in a consent statement
... patient Σ 1..1 Reference(Patient) Who the consent applies to
... period Σ 0..1 Period Period that this consent applies
... dateTime Σ 0..1 dateTime When this Consent was created or indexed
... consentingParty Σ 0..* Reference(Organization | Patient | Practitioner | RelatedPerson) Who is agreeing to the policy and exceptions
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:performer 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Who is agreeing to the policy and rules
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... actor Σ 0..* BackboneElement Who|what controlled by this consent (or group, by role)
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType . (extensible): How an actor is involved in the consent considerations
.... reference 1..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson) Resource for the actor (or group, by role)
... action Σ 0..* CodeableConcept Actions controlled by this consent
Binding: Consent Action Codes (example): Detailed codes for the consent action.
... organization Σ 0..* Reference(Organization) Custodian of the consent
... source[x] Σ 0..1 Source from which this consent is taken
.... sourceAttachment Attachment
.... sourceIdentifier Identifier
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy 0..* BackboneElement Policies covered by this consent
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... authority C 0..1 uri Enforcement source for policy
.... uri C 0..1 uri Specific policy covered by this consent
... policyRule ΣC 0..1 uri Policy that this consents to
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:policyRule 0..1 CodeableConcept R4: Regulation that this consents to additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.policyRule
Binding: R4ConsentPolicyForR3 (0.1.0) (extensible): Regulatory policy examples.
.... value 0..1 uri Primitive value for uri
... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: All Security Labels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... purpose Σ 0..* Coding ​Context of activities for which the agreement is made
Binding: PurposeOfUse|2014-03-26 (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels
... dataPeriod Σ 0..1 Period Timeframe for data controlled by this consent
... data Σ 0..* BackboneElement Data controlled by this consent
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... meaning Σ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions
.... reference Σ 1..1 Reference(Resource) The actual data reference
... except Σ 0..* BackboneElement Additional rule - addition or removal of permissions
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:provision 0..* (Complex) R4: Nested Exception Rules (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.provision
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... type Σ 1..1 code deny | permit
Binding: ConsentExceptType (required): How an exception statement is applied, such as adding additional consent or removing consent
.... period Σ 0..1 Period Timeframe for this exception
.... actor Σ 0..* BackboneElement Who|what controlled by this exception (or group, by role)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType . (extensible): How an actor is involved in the consent considerations
..... reference 1..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson) Resource for the actor (or group, by role)
.... action Σ 0..* CodeableConcept Actions controlled by this exception
Binding: Consent Action Codes (example): Detailed codes for the consent action.
.... securityLabel Σ 0..* Coding Security Labels that define affected resources
Binding: All Security Labels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose Σ 0..* Coding ​Context of activities covered by this exception
Binding: PurposeOfUse|2014-03-26 (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels
.... class Σ 0..* Coding e.g. Resource Type, Profile, or CDA etc
Binding: Consent Content Class (extensible): The class (type) of information a consent rule covers
.... code Σ 0..* Coding e.g. LOINC or SNOMED CT code, etc in the content
Binding: Consent Content Codes (example): If this code is found in an instance, then the exception applies
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 0..* CodeableConcept R4: e.g. LOINC or SNOMED CT code, etc. in the content additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Consent.provision.code
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... dataPeriod Σ 0..1 Period Timeframe for data controlled by this exception
.... data Σ 0..* BackboneElement Data controlled by this exception
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... meaning Σ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions
..... reference Σ 1..1 Reference(Resource) The actual data reference

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Consent.status Base required ConsentState 📍3.0.2 FHIR Std.
Consent.category Base example Consent Category Codes 📍3.0.2 FHIR Std.
Consent.actor.role Base extensible SecurityRoleType . 📍1.8.0 tx.fhir.org
Consent.action Base example Consent Action Codes 📍3.0.2 FHIR Std.
Consent.securityLabel Base extensible All Security Labels . 📍3.0.2 tx.fhir.org
Consent.purpose Base extensible PurposeOfUse . 📍2014-03-26 tx.fhir.org
Consent.data.meaning Base required ConsentDataMeaning 📍3.0.2 FHIR Std.
Consent.except.type Base required ConsentExceptType 📍3.0.2 FHIR Std.
Consent.except.actor.​role Base extensible SecurityRoleType . 📍1.8.0 tx.fhir.org
Consent.except.action Base example Consent Action Codes 📍3.0.2 FHIR Std.
Consent.except.securityLabel Base extensible All Security Labels . 📍3.0.2 tx.fhir.org
Consent.except.purpose Base extensible PurposeOfUse . 📍2014-03-26 tx.fhir.org
Consent.except.class Base extensible Consent Content Class 📍3.0.2 FHIR Std.
Consent.except.code Base example Consent Content Codes 📍3.0.2 FHIR Std.
Consent.except.data.​meaning Base required ConsentDataMeaning 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Consent If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ppc-1 error Consent Either a Policy or PolicyRule policy.exists() or policyRule.exists()

 

Other representations of profile: CSV, Excel, Schematron