Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Consent | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_Consent_R4B | ||
This cross-version profile allows R5 Consent content to be represented via FHIR R4B Consent resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| 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. |
| 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:grantor, Consent.extension:manager, Consent.extension:controller, Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.status, Consent.status.extension, Consent.status.extension: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:grantor, Consent.extension:manager, Consent.extension:controller, Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.status.extension, Consent.status.extension:status | 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
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  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 | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| 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 Constraints: dom-r4b | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
   extension:period |
0..1 | Period | R5: Effective period for this Consent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.period Constraints: ext-1 | |||||
| extension:grantor |
0..* | Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4B(0.1.0) | CareTeam | Cross-version Profile for R5.HealthcareService for use in FHIR R4B(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR R4B(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR R4B(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4B(0.1.0) | Practitioner | Cross-version Profile for R5.RelatedPerson for use in FHIR R4B(0.1.0) | RelatedPerson | Cross-version Profile for R5.PractitionerRole for use in FHIR R4B(0.1.0) | PractitionerRole) | R5: Who is granting rights according to the policy and rules (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor Constraints: ext-1 | |||||
| extension:manager |
0..* | Reference(Cross-version Profile for R5.HealthcareService for use in FHIR R4B(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR R4B(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR R4B(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4B(0.1.0) | Practitioner) | R5: Consent workflow management (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager Constraints: ext-1 | |||||
| extension:controller |
0..* | Reference(Cross-version Profile for R5.HealthcareService for use in FHIR R4B(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR R4B(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR R4B(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4B(0.1.0) | Practitioner) | R5: Consent Enforcer (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller Constraints: ext-1 | |||||
 extension:policyText |
0..* | Reference(Cross-version Profile for R5.DocumentReference for use in FHIR R4B(0.1.0) | Media) | R5: Human Readable Policy (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.policyText Constraints: ext-1 | |||||
 Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:decision |
?! | 0..1 | code | R5: deny | permit (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.decision Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level. Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | Identifier for this record (external references) | ||||
| status |
?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:status |
0..1 | code | R5: draft | active | inactive | not-done | entered-in-error | unknown URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.status Binding: R5ConsentStateCodesForR4B (0.1.0) (required): Indicates the state of the consent. Constraints: ext-1 | |||||
 value |
0..1 | code | Primitive value for code | |||||
| 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 |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | R5: subject 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:grantee |
0..1 | Reference(Resource) | R5: grantee 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 | ||||
 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 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
 extension:alternateReference |
0..1 | Reference(Resource) | R5: sourceReference 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. | ||||
| verification |
Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:verificationType |
0..1 | CodeableConcept | R5: Business case of verification (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.verification.verificationType Binding: R5ConsentVerificationForR4B (0.1.0) (example): Types of Verification/Validation. Constraints: ext-1 | |||||
| extension:verifiedBy |
0..1 | Reference(Cross-version Profile for R5.Organization for use in FHIR R4B(0.1.0) | Organization | Cross-version Profile for R5.Practitioner for use in FHIR R4B(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4B(0.1.0) | PractitionerRole) | R5: Person conducting verification (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.verification.verifiedBy 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:expression |
0..1 | Expression | R5: A computable expression of the consent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.expression 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 | ||||
| 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) | |||||
| 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 | ||||
| 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 | ||||
| provision |
0..* | See provision (Consent) | Nested Exception Rules | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.language | Base | preferred | Common Languages | 📍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.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.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. |
| 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.implicitRules, Consent.language, Consent.text, Consent.extension, Consent.extension:period, Consent.extension:grantor, Consent.extension:manager, Consent.extension:controller, Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.identifier, Consent.status, Consent.status.extension, Consent.status.extension:status, Consent.scope, Consent.category, Consent.patient, Consent.patient.extension, Consent.patient.extension:subject, Consent.patient.reference, Consent.patient.type, Consent.patient.identifier, Consent.patient.display, Consent.dateTime, Consent.performer, Consent.performer.extension, Consent.performer.extension:grantee, Consent.performer.reference, Consent.performer.type, Consent.performer.identifier, Consent.performer.display, Consent.organization, 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.verification, Consent.verification.extension, Consent.verification.extension:verificationType, Consent.verification.extension:verifiedBy, Consent.verification.modifierExtension, Consent.verification.verified, Consent.verification.verifiedWith, Consent.verification.verificationDate, Consent.provision, Consent.provision.extension, Consent.provision.extension:expression, Consent.provision.modifierExtension, Consent.provision.type, Consent.provision.period, Consent.provision.actor, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.actor.role, Consent.provision.actor.reference, Consent.provision.action, Consent.provision.securityLabel, Consent.provision.purpose, Consent.provision.class, Consent.provision.code, Consent.provision.dataPeriod, Consent.provision.data, Consent.provision.data.extension, Consent.provision.data.modifierExtension, Consent.provision.data.meaning, Consent.provision.data.reference, Consent.provision.provision | 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:grantor, Consent.extension:manager, Consent.extension:controller, Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.status.extension, Consent.status.extension:status, Consent.patient.extension, Consent.patient.extension:subject, Consent.performer.extension, Consent.performer.extension:grantee, Consent.source[x].extension, Consent.source[x].extension:alternateReference, Consent.policy.extension, Consent.policy.modifierExtension, Consent.verification.extension, Consent.verification.extension:verificationType, Consent.verification.extension:verifiedBy, Consent.verification.modifierExtension, Consent.provision.extension, Consent.provision.extension:expression, Consent.provision.modifierExtension, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.data.extension, Consent.provision.data.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
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| 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. |
| 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:grantor, Consent.extension:manager, Consent.extension:controller, Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.status, Consent.status.extension, Consent.status.extension: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:grantor, Consent.extension:manager, Consent.extension:controller, Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.status.extension, Consent.status.extension:status | 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
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| 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 Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:period |
0..1 | Period | R5: Effective period for this Consent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.period Constraints: ext-1 | |||||
| extension:grantor |
0..* | Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4B(0.1.0) | CareTeam | Cross-version Profile for R5.HealthcareService for use in FHIR R4B(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR R4B(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR R4B(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4B(0.1.0) | Practitioner | Cross-version Profile for R5.RelatedPerson for use in FHIR R4B(0.1.0) | RelatedPerson | Cross-version Profile for R5.PractitionerRole for use in FHIR R4B(0.1.0) | PractitionerRole) | R5: Who is granting rights according to the policy and rules (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor Constraints: ext-1 | |||||
| extension:manager |
0..* | Reference(Cross-version Profile for R5.HealthcareService for use in FHIR R4B(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR R4B(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR R4B(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4B(0.1.0) | Practitioner) | R5: Consent workflow management (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager Constraints: ext-1 | |||||
| extension:controller |
0..* | Reference(Cross-version Profile for R5.HealthcareService for use in FHIR R4B(0.1.0) | HealthcareService | Cross-version Profile for R5.Organization for use in FHIR R4B(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR R4B(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4B(0.1.0) | Practitioner) | R5: Consent Enforcer (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller Constraints: ext-1 | |||||
| extension:policyText |
0..* | Reference(Cross-version Profile for R5.DocumentReference for use in FHIR R4B(0.1.0) | Media) | R5: Human Readable Policy (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.policyText Constraints: ext-1 | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:decision |
?! | 0..1 | code | R5: deny | permit (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.decision Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level. Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | Identifier for this record (external references) | ||||
| status |
?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:status |
0..1 | code | R5: draft | active | inactive | not-done | entered-in-error | unknown URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.status Binding: R5ConsentStateCodesForR4B (0.1.0) (required): Indicates the state of the consent. Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| 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 |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | R5: subject 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:grantee |
0..1 | Reference(Resource) | R5: grantee 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 | ||||
| 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 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:alternateReference |
0..1 | Reference(Resource) | R5: sourceReference 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. | ||||
| verification |
Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:verificationType |
0..1 | CodeableConcept | R5: Business case of verification (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.verification.verificationType Binding: R5ConsentVerificationForR4B (0.1.0) (example): Types of Verification/Validation. Constraints: ext-1 | |||||
| extension:verifiedBy |
0..1 | Reference(Cross-version Profile for R5.Organization for use in FHIR R4B(0.1.0) | Organization | Cross-version Profile for R5.Practitioner for use in FHIR R4B(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4B(0.1.0) | PractitionerRole) | R5: Person conducting verification (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.verification.verifiedBy 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:expression |
0..1 | Expression | R5: A computable expression of the consent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.provision.expression 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 | ||||
| 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) | |||||
| 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 | ||||
| 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 | ||||
| provision |
0..* | See provision (Consent) | Nested Exception Rules | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Consent.language | Base | preferred | Common Languages | 📍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.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.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. |
| 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.implicitRules, Consent.language, Consent.text, Consent.extension, Consent.extension:period, Consent.extension:grantor, Consent.extension:manager, Consent.extension:controller, Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.identifier, Consent.status, Consent.status.extension, Consent.status.extension:status, Consent.scope, Consent.category, Consent.patient, Consent.patient.extension, Consent.patient.extension:subject, Consent.patient.reference, Consent.patient.type, Consent.patient.identifier, Consent.patient.display, Consent.dateTime, Consent.performer, Consent.performer.extension, Consent.performer.extension:grantee, Consent.performer.reference, Consent.performer.type, Consent.performer.identifier, Consent.performer.display, Consent.organization, 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.verification, Consent.verification.extension, Consent.verification.extension:verificationType, Consent.verification.extension:verifiedBy, Consent.verification.modifierExtension, Consent.verification.verified, Consent.verification.verifiedWith, Consent.verification.verificationDate, Consent.provision, Consent.provision.extension, Consent.provision.extension:expression, Consent.provision.modifierExtension, Consent.provision.type, Consent.provision.period, Consent.provision.actor, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.actor.role, Consent.provision.actor.reference, Consent.provision.action, Consent.provision.securityLabel, Consent.provision.purpose, Consent.provision.class, Consent.provision.code, Consent.provision.dataPeriod, Consent.provision.data, Consent.provision.data.extension, Consent.provision.data.modifierExtension, Consent.provision.data.meaning, Consent.provision.data.reference, Consent.provision.provision | 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:grantor, Consent.extension:manager, Consent.extension:controller, Consent.extension:policyText, Consent.modifierExtension, Consent.modifierExtension:decision, Consent.status.extension, Consent.status.extension:status, Consent.patient.extension, Consent.patient.extension:subject, Consent.performer.extension, Consent.performer.extension:grantee, Consent.source[x].extension, Consent.source[x].extension:alternateReference, Consent.policy.extension, Consent.policy.modifierExtension, Consent.verification.extension, Consent.verification.extension:verificationType, Consent.verification.extension:verifiedBy, Consent.verification.modifierExtension, Consent.provision.extension, Consent.provision.extension:expression, Consent.provision.modifierExtension, Consent.provision.actor.extension, Consent.provision.actor.modifierExtension, Consent.provision.data.extension, Consent.provision.data.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
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change