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

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

Resource Profile: Profile_R3_Consent_R4B

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

This cross-version profile allows STU3 Consent content to be represented via FHIR R4B 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(4.3.0) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
... 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
Constraints: ext-1
.... extension:period 0..1 Period STU3: Period that this consent applies (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.period
Constraints: ext-1
.... extension:source 0..1 Attachment, Identifier STU3: source additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.source
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... scope ?!Σ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
... category Σ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📍4.3.0 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.3.0 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error Consent.implicitRules, Consent.extension, Consent.extension:period, Consent.extension:source, Consent.modifierExtension, Consent.status, Consent.scope, Consent.category All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Consent.extension, Consent.extension:period, Consent.extension:source, Consent.modifierExtension 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()
ppc-2 error Consent IF Scope=privacy, there must be a patient patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3 error Consent IF Scope=research, there must be a patient patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4 error Consent IF Scope=adr, there must be a patient patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5 error Consent IF Scope=treatment, there must be a patient patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* Consent(4.3.0) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:period 0..1 Period STU3: Period that this consent applies (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.period
.... extension:source 0..1 Attachment, Identifier STU3: source additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.source
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..1 Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.identifier
... patient
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 1..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... performer
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:consentingParty 0..* Reference(Resource) STU3: Who is agreeing to the policy and exceptions
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... organization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:organization 0..* Reference(Resource) STU3: organization additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... sourceReference
.... Slices for extension Content/Rules for all slices
..... extension:alternateReference 0..1 Reference(Resource) STU3: source additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... policyRule
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:policyRule 0..1 uri STU3: Policy that this consents to additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.policyRule
... provision
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period STU3: Timeframe for this exception additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.except.period
.... actor
..... reference
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:reference 0..1 Reference(Resource) STU3: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
....... extension:reference 0..1 Reference(Resource) STU3: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... dataPeriod
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:dataPeriod 0..1 Period STU3: Timeframe for data controlled by this consent additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.dataPeriod
...... extension:dataPeriod 0..1 Period STU3: Timeframe for data controlled by this exception additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.except.dataPeriod
.... data
..... reference
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:reference 0..1 Reference(Resource) STU3: reference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
....... extension:reference 0..1 Reference(Resource) STU3: reference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* Consent(4.3.0) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:period 0..1 Period STU3: Period that this consent applies (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.period
Constraints: ext-1
.... extension:source 0..1 Attachment, Identifier STU3: source additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.source
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifier for this record (external references)
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..1 Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
... scope ?!Σ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
... category Σ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
... patient Σ 0..1 Reference(Patient) Who the consent applies to
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 1..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... dateTime Σ 0..1 dateTime When this Consent was created or indexed
... performer Σ 0..* Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:consentingParty 0..1 Reference(Resource) STU3: Who is agreeing to the policy and exceptions
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... organization Σ 0..* Reference(Organization) Custodian of the consent
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:organization 0..1 Reference(Resource) STU3: organization additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... source[x] Σ 0..1 Source from which this consent is taken
.... source[x]All Types Content/Rules for all Types
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:alternateReference 0..1 Reference(Resource) STU3: source additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... sourceAttachment Attachment
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy 0..* BackboneElement Policies covered by this consent
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... authority C 0..1 uri Enforcement source for policy
.... uri C 0..1 uri Specific policy covered by this consent
... policyRule ΣC 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:policyRule 0..1 uri STU3: Policy that this consents to additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.policyRule
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... verification Σ 0..* BackboneElement Consent Verified by patient or family
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... verified Σ 1..1 boolean Has been verified
.... verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
.... verificationDate 0..1 dateTime When consent verified
... provision Σ 0..1 BackboneElement Constraints to the base Consent.policyRule
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type Σ 0..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
.... period Σ 0..1 Period Timeframe for this rule
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:period 0..1 Period STU3: Timeframe for this exception additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.except.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... actor 0..* BackboneElement Who|what controlled by this rule (or group, by role)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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 | PractitionerRole) Resource for the actor (or group, by role)
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:reference 0..1 Reference(Resource) STU3: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
....... extension:reference 0..1 Reference(Resource) STU3: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... action Σ 0..* CodeableConcept Actions controlled by this rule
Binding: ConsentActionCodes (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 rule
Binding: PurposeOfUse (3.1.0) (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, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
.... code Σ 0..* CodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
.... dataPeriod Σ 0..1 Period Timeframe for data controlled by this rule
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:dataPeriod 0..1 Period STU3: Timeframe for data controlled by this consent additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.dataPeriod
Constraints: ext-1
...... extension:dataPeriod 0..1 Period STU3: Timeframe for data controlled by this exception additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.except.dataPeriod
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... data Σ 0..* BackboneElement Data controlled by this rule
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:reference 0..1 Reference(Resource) STU3: reference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
....... extension:reference 0..1 Reference(Resource) STU3: reference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... provision 0..* See provision (Consent) Nested Exception Rules

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Consent.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Consent.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Consent.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Consent.identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
Consent.identifier.type Base extensible IdentifierType 📍4.3.0 FHIR Std.
Consent.status Base required ConsentState 📍4.3.0 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.3.0 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.3.0 FHIR Std.
Consent.patient.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Consent.performer.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Consent.organization.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.3.0 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.3.0 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.3.0 FHIR Std.
Consent.provision.actor.​reference.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.3.0 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📍3.1.0 THO v7.1
Consent.provision.class Base extensible Consent Content Class 📍4.3.0 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.3.0 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.3.0 FHIR Std.
Consent.provision.data.​reference.type Base extensible ResourceType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning Consent.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Consent.meta, Consent.meta.extension, Consent.meta.extension:meta, Consent.meta.versionId, Consent.meta.lastUpdated, Consent.meta.source, Consent.meta.profile, Consent.meta.security, Consent.meta.tag, Consent.implicitRules, Consent.language, Consent.text, Consent.text.extension, Consent.text.extension:text, Consent.text.status, Consent.text.div, Consent.extension, Consent.extension:period, Consent.extension:source, Consent.modifierExtension, Consent.identifier, Consent.identifier.extension, Consent.identifier.extension:identifier, Consent.identifier.use, Consent.identifier.type, Consent.identifier.system, Consent.identifier.value, Consent.identifier.period, Consent.identifier.assigner, Consent.status, Consent.scope, Consent.category, Consent.patient, Consent.patient.extension, Consent.patient.extension:patient, Consent.patient.reference, Consent.patient.type, Consent.patient.identifier, Consent.patient.display, Consent.dateTime, Consent.performer, Consent.performer.extension, Consent.performer.extension:consentingParty, Consent.performer.reference, Consent.performer.type, Consent.performer.identifier, Consent.performer.display, Consent.organization, Consent.organization.extension, Consent.organization.extension:organization, Consent.organization.reference, Consent.organization.type, Consent.organization.identifier, Consent.organization.display, Consent.source[x], Consent.source[x].extension, Consent.source[x].extension:alternateReference, Consent.policy, Consent.policy.extension, Consent.policy.modifierExtension, Consent.policy.authority, Consent.policy.uri, Consent.policyRule, Consent.policyRule.extension, Consent.policyRule.extension:policyRule, Consent.policyRule.coding, Consent.policyRule.text, Consent.verification, Consent.verification.extension, Consent.verification.modifierExtension, Consent.verification.verified, Consent.verification.verifiedWith, Consent.verification.verificationDate, Consent.provision, Consent.provision.extension, Consent.provision.modifierExtension, Consent.provision.type, Consent.provision.period, Consent.provision.period.extension, Consent.provision.period.extension:period, Consent.provision.period.start, Consent.provision.period.end, Consent.provision.actor, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.actor.role, Consent.provision.actor.reference, Consent.provision.actor.reference.extension, Consent.provision.actor.reference.extension:reference, Consent.provision.actor.reference.extension:reference, Consent.provision.actor.reference.reference, Consent.provision.actor.reference.type, Consent.provision.actor.reference.identifier, Consent.provision.actor.reference.display, Consent.provision.action, Consent.provision.securityLabel, Consent.provision.purpose, Consent.provision.class, Consent.provision.code, Consent.provision.dataPeriod, Consent.provision.dataPeriod.extension, Consent.provision.dataPeriod.extension:dataPeriod, Consent.provision.dataPeriod.extension:dataPeriod, Consent.provision.dataPeriod.start, Consent.provision.dataPeriod.end, Consent.provision.data, Consent.provision.data.extension, Consent.provision.data.modifierExtension, Consent.provision.data.meaning, Consent.provision.data.reference, Consent.provision.data.reference.extension, Consent.provision.data.reference.extension:reference, Consent.provision.data.reference.extension:reference, Consent.provision.data.reference.reference, Consent.provision.data.reference.type, Consent.provision.data.reference.identifier, Consent.provision.data.reference.display, Consent.provision.provision All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Consent.meta.extension, Consent.meta.extension:meta, Consent.text.extension, Consent.text.extension:text, Consent.extension, Consent.extension:period, Consent.extension:source, Consent.modifierExtension, Consent.identifier.extension, Consent.identifier.extension:identifier, Consent.patient.extension, Consent.patient.extension:patient, Consent.performer.extension, Consent.performer.extension:consentingParty, Consent.organization.extension, Consent.organization.extension:organization, Consent.source[x].extension, Consent.source[x].extension:alternateReference, Consent.policy.extension, Consent.policy.modifierExtension, Consent.policyRule.extension, Consent.policyRule.extension:policyRule, Consent.verification.extension, Consent.verification.modifierExtension, Consent.provision.extension, Consent.provision.modifierExtension, Consent.provision.period.extension, Consent.provision.period.extension:period, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.actor.reference.extension, Consent.provision.actor.reference.extension:reference, Consent.provision.actor.reference.extension:reference, Consent.provision.dataPeriod.extension, Consent.provision.dataPeriod.extension:dataPeriod, Consent.provision.dataPeriod.extension:dataPeriod, Consent.provision.data.extension, Consent.provision.data.modifierExtension, Consent.provision.data.reference.extension, Consent.provision.data.reference.extension:reference, Consent.provision.data.reference.extension:reference 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()
ppc-2 error Consent IF Scope=privacy, there must be a patient patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3 error Consent IF Scope=research, there must be a patient patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4 error Consent IF Scope=adr, there must be a patient patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5 error Consent IF Scope=treatment, there must be a patient patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()
txt-1 error Consent.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Consent.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* Consent(4.3.0) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
... 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
Constraints: ext-1
.... extension:period 0..1 Period STU3: Period that this consent applies (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.period
Constraints: ext-1
.... extension:source 0..1 Attachment, Identifier STU3: source additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.source
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... scope ?!Σ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
... category Σ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📍4.3.0 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.3.0 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error Consent.implicitRules, Consent.extension, Consent.extension:period, Consent.extension:source, Consent.modifierExtension, Consent.status, Consent.scope, Consent.category All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Consent.extension, Consent.extension:period, Consent.extension:source, Consent.modifierExtension 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()
ppc-2 error Consent IF Scope=privacy, there must be a patient patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3 error Consent IF Scope=research, there must be a patient patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4 error Consent IF Scope=adr, there must be a patient patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5 error Consent IF Scope=treatment, there must be a patient patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

Differential View

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* Consent(4.3.0) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:period 0..1 Period STU3: Period that this consent applies (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.period
.... extension:source 0..1 Attachment, Identifier STU3: source additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.source
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..1 Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.identifier
... patient
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 1..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... performer
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:consentingParty 0..* Reference(Resource) STU3: Who is agreeing to the policy and exceptions
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... organization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:organization 0..* Reference(Resource) STU3: organization additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... sourceReference
.... Slices for extension Content/Rules for all slices
..... extension:alternateReference 0..1 Reference(Resource) STU3: source additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... policyRule
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:policyRule 0..1 uri STU3: Policy that this consents to additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.policyRule
... provision
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period STU3: Timeframe for this exception additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.except.period
.... actor
..... reference
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:reference 0..1 Reference(Resource) STU3: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
....... extension:reference 0..1 Reference(Resource) STU3: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... dataPeriod
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:dataPeriod 0..1 Period STU3: Timeframe for data controlled by this consent additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.dataPeriod
...... extension:dataPeriod 0..1 Period STU3: Timeframe for data controlled by this exception additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.except.dataPeriod
.... data
..... reference
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:reference 0..1 Reference(Resource) STU3: reference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
....... extension:reference 0..1 Reference(Resource) STU3: reference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* Consent(4.3.0) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:period 0..1 Period STU3: Period that this consent applies (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.period
Constraints: ext-1
.... extension:source 0..1 Attachment, Identifier STU3: source additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.source
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifier for this record (external references)
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..1 Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
... scope ?!Σ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
... category Σ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
... patient Σ 0..1 Reference(Patient) Who the consent applies to
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 1..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... dateTime Σ 0..1 dateTime When this Consent was created or indexed
... performer Σ 0..* Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:consentingParty 0..1 Reference(Resource) STU3: Who is agreeing to the policy and exceptions
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... organization Σ 0..* Reference(Organization) Custodian of the consent
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:organization 0..1 Reference(Resource) STU3: organization additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... source[x] Σ 0..1 Source from which this consent is taken
.... source[x]All Types Content/Rules for all Types
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:alternateReference 0..1 Reference(Resource) STU3: source additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... sourceAttachment Attachment
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy 0..* BackboneElement Policies covered by this consent
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... authority C 0..1 uri Enforcement source for policy
.... uri C 0..1 uri Specific policy covered by this consent
... policyRule ΣC 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:policyRule 0..1 uri STU3: Policy that this consents to additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.policyRule
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... verification Σ 0..* BackboneElement Consent Verified by patient or family
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... verified Σ 1..1 boolean Has been verified
.... verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
.... verificationDate 0..1 dateTime When consent verified
... provision Σ 0..1 BackboneElement Constraints to the base Consent.policyRule
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type Σ 0..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
.... period Σ 0..1 Period Timeframe for this rule
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:period 0..1 Period STU3: Timeframe for this exception additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.except.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... actor 0..* BackboneElement Who|what controlled by this rule (or group, by role)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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 | PractitionerRole) Resource for the actor (or group, by role)
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:reference 0..1 Reference(Resource) STU3: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
....... extension:reference 0..1 Reference(Resource) STU3: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... action Σ 0..* CodeableConcept Actions controlled by this rule
Binding: ConsentActionCodes (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 rule
Binding: PurposeOfUse (3.1.0) (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, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
.... code Σ 0..* CodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
.... dataPeriod Σ 0..1 Period Timeframe for data controlled by this rule
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:dataPeriod 0..1 Period STU3: Timeframe for data controlled by this consent additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.dataPeriod
Constraints: ext-1
...... extension:dataPeriod 0..1 Period STU3: Timeframe for data controlled by this exception additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Consent.except.dataPeriod
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... data Σ 0..* BackboneElement Data controlled by this rule
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:reference 0..1 Reference(Resource) STU3: reference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
....... extension:reference 0..1 Reference(Resource) STU3: reference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... provision 0..* See provision (Consent) Nested Exception Rules

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Consent.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Consent.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Consent.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Consent.identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
Consent.identifier.type Base extensible IdentifierType 📍4.3.0 FHIR Std.
Consent.status Base required ConsentState 📍4.3.0 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.3.0 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.3.0 FHIR Std.
Consent.patient.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Consent.performer.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Consent.organization.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.3.0 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.3.0 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.3.0 FHIR Std.
Consent.provision.actor.​reference.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.3.0 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📍3.1.0 THO v7.1
Consent.provision.class Base extensible Consent Content Class 📍4.3.0 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.3.0 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.3.0 FHIR Std.
Consent.provision.data.​reference.type Base extensible ResourceType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning Consent.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Consent.meta, Consent.meta.extension, Consent.meta.extension:meta, Consent.meta.versionId, Consent.meta.lastUpdated, Consent.meta.source, Consent.meta.profile, Consent.meta.security, Consent.meta.tag, Consent.implicitRules, Consent.language, Consent.text, Consent.text.extension, Consent.text.extension:text, Consent.text.status, Consent.text.div, Consent.extension, Consent.extension:period, Consent.extension:source, Consent.modifierExtension, Consent.identifier, Consent.identifier.extension, Consent.identifier.extension:identifier, Consent.identifier.use, Consent.identifier.type, Consent.identifier.system, Consent.identifier.value, Consent.identifier.period, Consent.identifier.assigner, Consent.status, Consent.scope, Consent.category, Consent.patient, Consent.patient.extension, Consent.patient.extension:patient, Consent.patient.reference, Consent.patient.type, Consent.patient.identifier, Consent.patient.display, Consent.dateTime, Consent.performer, Consent.performer.extension, Consent.performer.extension:consentingParty, Consent.performer.reference, Consent.performer.type, Consent.performer.identifier, Consent.performer.display, Consent.organization, Consent.organization.extension, Consent.organization.extension:organization, Consent.organization.reference, Consent.organization.type, Consent.organization.identifier, Consent.organization.display, Consent.source[x], Consent.source[x].extension, Consent.source[x].extension:alternateReference, Consent.policy, Consent.policy.extension, Consent.policy.modifierExtension, Consent.policy.authority, Consent.policy.uri, Consent.policyRule, Consent.policyRule.extension, Consent.policyRule.extension:policyRule, Consent.policyRule.coding, Consent.policyRule.text, Consent.verification, Consent.verification.extension, Consent.verification.modifierExtension, Consent.verification.verified, Consent.verification.verifiedWith, Consent.verification.verificationDate, Consent.provision, Consent.provision.extension, Consent.provision.modifierExtension, Consent.provision.type, Consent.provision.period, Consent.provision.period.extension, Consent.provision.period.extension:period, Consent.provision.period.start, Consent.provision.period.end, Consent.provision.actor, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.actor.role, Consent.provision.actor.reference, Consent.provision.actor.reference.extension, Consent.provision.actor.reference.extension:reference, Consent.provision.actor.reference.extension:reference, Consent.provision.actor.reference.reference, Consent.provision.actor.reference.type, Consent.provision.actor.reference.identifier, Consent.provision.actor.reference.display, Consent.provision.action, Consent.provision.securityLabel, Consent.provision.purpose, Consent.provision.class, Consent.provision.code, Consent.provision.dataPeriod, Consent.provision.dataPeriod.extension, Consent.provision.dataPeriod.extension:dataPeriod, Consent.provision.dataPeriod.extension:dataPeriod, Consent.provision.dataPeriod.start, Consent.provision.dataPeriod.end, Consent.provision.data, Consent.provision.data.extension, Consent.provision.data.modifierExtension, Consent.provision.data.meaning, Consent.provision.data.reference, Consent.provision.data.reference.extension, Consent.provision.data.reference.extension:reference, Consent.provision.data.reference.extension:reference, Consent.provision.data.reference.reference, Consent.provision.data.reference.type, Consent.provision.data.reference.identifier, Consent.provision.data.reference.display, Consent.provision.provision All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Consent.meta.extension, Consent.meta.extension:meta, Consent.text.extension, Consent.text.extension:text, Consent.extension, Consent.extension:period, Consent.extension:source, Consent.modifierExtension, Consent.identifier.extension, Consent.identifier.extension:identifier, Consent.patient.extension, Consent.patient.extension:patient, Consent.performer.extension, Consent.performer.extension:consentingParty, Consent.organization.extension, Consent.organization.extension:organization, Consent.source[x].extension, Consent.source[x].extension:alternateReference, Consent.policy.extension, Consent.policy.modifierExtension, Consent.policyRule.extension, Consent.policyRule.extension:policyRule, Consent.verification.extension, Consent.verification.modifierExtension, Consent.provision.extension, Consent.provision.modifierExtension, Consent.provision.period.extension, Consent.provision.period.extension:period, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.actor.reference.extension, Consent.provision.actor.reference.extension:reference, Consent.provision.actor.reference.extension:reference, Consent.provision.dataPeriod.extension, Consent.provision.dataPeriod.extension:dataPeriod, Consent.provision.dataPeriod.extension:dataPeriod, Consent.provision.data.extension, Consent.provision.data.modifierExtension, Consent.provision.data.reference.extension, Consent.provision.data.reference.extension:reference, Consent.provision.data.reference.extension:reference 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()
ppc-2 error Consent IF Scope=privacy, there must be a patient patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3 error Consent IF Scope=research, there must be a patient patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4 error Consent IF Scope=adr, there must be a patient patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5 error Consent IF Scope=treatment, there must be a patient patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()
txt-1 error Consent.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Consent.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron