Atrius India Core FHIR Implementation Guide
0.1.0 - ci-build

Atrius India Core FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Atrius India Core Surgical Consent

Official URL: https://atrius.in/fhir/r4/atrius-in/StructureDefinition/atrius-in-surgical-consent Version: 0.1.0
Draft as of 2026-08-30 Computable Name: AtriusInSurgicalConsent
Other Identifiers: OID:1.3.6.1.4.1.66219.1.42.140

Consent for an operative / OT procedure linked to an Encounter.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* AtriusInConsent(0.1.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:encounter S 0..1 Reference(Atrius India Core Encounter(0.1.0)) Consent encounter
URL: https://atrius.in/fhir/StructureDefinition/atrius-consent-encounter
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... scope ?!SΣ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
.... coding Σ 1..* Coding Code defined by a terminology system
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
..... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: treatment
... category SΣ 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.
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:surgical SΣ 1..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://atrius.in/fhir/CodeSystem/atrius-consent-category
...... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: surgical
... patient SΣ 1..1 Reference(Atrius India Core Patient(0.1.0)) Who the consent applies to
... dateTime SΣ 0..1 dateTime When this Consent was created or indexed
... performer SΣ 0..* Reference(Atrius India Core Organization(0.1.0) | Atrius India Core Practitioner(0.1.0) | Atrius India Core PractitionerRole(0.1.0) | Atrius India Core Patient(0.1.0) | Atrius India Core RelatedPerson(0.1.0)) Who is agreeing to the policy and rules
... organization SΣ 0..* Reference(Atrius India Core Organization(0.1.0)) Custodian of the consent
... Slices for source[x] SΣ 0..1 Source from which this consent is taken
Slice: Unordered, Open by type:$this
.... sourceAttachment Attachment
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
.... source[x]:sourceReference Σ 0..1 Reference(Atrius India Core Consent(0.1.0) | Atrius India Core DocumentReference(0.1.0)) Source from which this consent is taken
... provision SΣ 0..1 BackboneElement Constraints to the base Consent.policyRule
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 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 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(canonical) = '#').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:encounter, Consent.modifierExtension, Consent.status, Consent.scope, Consent.scope.coding, Consent.scope.coding.system, Consent.scope.coding.code, Consent.category, Consent.category.coding, Consent.category.coding:surgical, Consent.category.coding:surgical.system, Consent.category.coding:surgical.code, Consent.patient, Consent.dateTime, Consent.performer, Consent.organization, Consent.source[x], Consent.source[x]:sourceReference, Consent.provision, Consent.provision.modifierExtension All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Consent.extension, Consent.extension:encounter, Consent.modifierExtension, Consent.provision.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()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* AtriusInConsent(0.1.0) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:encounter S 0..1 Reference(Atrius India Core Encounter(0.1.0)) Consent encounter
URL: https://atrius.in/fhir/StructureDefinition/atrius-consent-encounter
... status 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Required Pattern: active
... scope
.... coding 1..* Coding Code defined by a terminology system
..... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
..... code 0..1 code Symbol in syntax defined by the system
Required Pattern: treatment
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:surgical S 1..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Required Pattern: https://atrius.in/fhir/CodeSystem/atrius-consent-category
...... code 1..1 code Symbol in syntax defined by the system
Required Pattern: surgical

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* AtriusInConsent(0.1.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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:encounter S 0..1 Reference(Atrius India Core Encounter(0.1.0)) Consent encounter
URL: https://atrius.in/fhir/StructureDefinition/atrius-consent-encounter
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
... status ?!SΣ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Required Pattern: active
... scope ?!SΣ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... coding Σ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: treatment
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... category SΣ 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.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:surgical SΣ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://atrius.in/fhir/CodeSystem/atrius-consent-category
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: surgical
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(Atrius India Core Patient(0.1.0)) Who the consent applies to
... dateTime SΣ 0..1 dateTime When this Consent was created or indexed
... performer SΣ 0..* Reference(Atrius India Core Organization(0.1.0) | Atrius India Core Practitioner(0.1.0) | Atrius India Core PractitionerRole(0.1.0) | Atrius India Core Patient(0.1.0) | Atrius India Core RelatedPerson(0.1.0)) Who is agreeing to the policy and rules
... organization SΣ 0..* Reference(Atrius India Core Organization(0.1.0)) Custodian of the consent
... Slices for source[x] SΣ 0..1 Source from which this consent is taken
Slice: Unordered, Open by type:$this
.... sourceAttachment Attachment
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
.... source[x]:sourceReference Σ 0..1 Reference(Atrius India Core Consent(0.1.0) | Atrius India Core DocumentReference(0.1.0)) Source from which this consent is taken
... 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
.... 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 SΣ 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
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.0.1 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.0.1 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📍3.1.0 THO v7.2
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 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 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(canonical) = '#').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.meta, Consent.implicitRules, Consent.language, Consent.text, Consent.extension, Consent.extension:encounter, Consent.modifierExtension, Consent.identifier, Consent.status, Consent.scope, Consent.scope.extension, Consent.scope.coding, Consent.scope.coding.extension, Consent.scope.coding.system, Consent.scope.coding.version, Consent.scope.coding.code, Consent.scope.coding.display, Consent.scope.coding.userSelected, Consent.scope.text, Consent.category, Consent.category.extension, Consent.category.coding, Consent.category.coding:surgical, Consent.category.coding:surgical.extension, Consent.category.coding:surgical.system, Consent.category.coding:surgical.version, Consent.category.coding:surgical.code, Consent.category.coding:surgical.display, Consent.category.coding:surgical.userSelected, Consent.category.text, Consent.patient, Consent.dateTime, Consent.performer, Consent.organization, Consent.source[x], Consent.source[x]:sourceReference, Consent.policy, Consent.policy.extension, Consent.policy.modifierExtension, Consent.policy.authority, Consent.policy.uri, Consent.policyRule, 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.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:encounter, Consent.modifierExtension, Consent.scope.extension, Consent.scope.coding.extension, Consent.category.extension, Consent.category.coding:surgical.extension, Consent.policy.extension, Consent.policy.modifierExtension, Consent.verification.extension, Consent.verification.modifierExtension, Consent.provision.extension, 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()

Summary

Mandatory: 5 elements
Must-Support: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Consent.category.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* AtriusInConsent(0.1.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:encounter S 0..1 Reference(Atrius India Core Encounter(0.1.0)) Consent encounter
URL: https://atrius.in/fhir/StructureDefinition/atrius-consent-encounter
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... scope ?!SΣ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
.... coding Σ 1..* Coding Code defined by a terminology system
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
..... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: treatment
... category SΣ 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.
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:surgical SΣ 1..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://atrius.in/fhir/CodeSystem/atrius-consent-category
...... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: surgical
... patient SΣ 1..1 Reference(Atrius India Core Patient(0.1.0)) Who the consent applies to
... dateTime SΣ 0..1 dateTime When this Consent was created or indexed
... performer SΣ 0..* Reference(Atrius India Core Organization(0.1.0) | Atrius India Core Practitioner(0.1.0) | Atrius India Core PractitionerRole(0.1.0) | Atrius India Core Patient(0.1.0) | Atrius India Core RelatedPerson(0.1.0)) Who is agreeing to the policy and rules
... organization SΣ 0..* Reference(Atrius India Core Organization(0.1.0)) Custodian of the consent
... Slices for source[x] SΣ 0..1 Source from which this consent is taken
Slice: Unordered, Open by type:$this
.... sourceAttachment Attachment
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
.... source[x]:sourceReference Σ 0..1 Reference(Atrius India Core Consent(0.1.0) | Atrius India Core DocumentReference(0.1.0)) Source from which this consent is taken
... provision SΣ 0..1 BackboneElement Constraints to the base Consent.policyRule
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 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 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(canonical) = '#').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:encounter, Consent.modifierExtension, Consent.status, Consent.scope, Consent.scope.coding, Consent.scope.coding.system, Consent.scope.coding.code, Consent.category, Consent.category.coding, Consent.category.coding:surgical, Consent.category.coding:surgical.system, Consent.category.coding:surgical.code, Consent.patient, Consent.dateTime, Consent.performer, Consent.organization, Consent.source[x], Consent.source[x]:sourceReference, Consent.provision, Consent.provision.modifierExtension All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Consent.extension, Consent.extension:encounter, Consent.modifierExtension, Consent.provision.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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* AtriusInConsent(0.1.0) A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:encounter S 0..1 Reference(Atrius India Core Encounter(0.1.0)) Consent encounter
URL: https://atrius.in/fhir/StructureDefinition/atrius-consent-encounter
... status 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Required Pattern: active
... scope
.... coding 1..* Coding Code defined by a terminology system
..... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
..... code 0..1 code Symbol in syntax defined by the system
Required Pattern: treatment
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:surgical S 1..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Required Pattern: https://atrius.in/fhir/CodeSystem/atrius-consent-category
...... code 1..1 code Symbol in syntax defined by the system
Required Pattern: surgical

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* AtriusInConsent(0.1.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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:encounter S 0..1 Reference(Atrius India Core Encounter(0.1.0)) Consent encounter
URL: https://atrius.in/fhir/StructureDefinition/atrius-consent-encounter
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
... status ?!SΣ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Required Pattern: active
... scope ?!SΣ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... coding Σ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: treatment
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... category SΣ 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.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:surgical SΣ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://atrius.in/fhir/CodeSystem/atrius-consent-category
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: surgical
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(Atrius India Core Patient(0.1.0)) Who the consent applies to
... dateTime SΣ 0..1 dateTime When this Consent was created or indexed
... performer SΣ 0..* Reference(Atrius India Core Organization(0.1.0) | Atrius India Core Practitioner(0.1.0) | Atrius India Core PractitionerRole(0.1.0) | Atrius India Core Patient(0.1.0) | Atrius India Core RelatedPerson(0.1.0)) Who is agreeing to the policy and rules
... organization SΣ 0..* Reference(Atrius India Core Organization(0.1.0)) Custodian of the consent
... Slices for source[x] SΣ 0..1 Source from which this consent is taken
Slice: Unordered, Open by type:$this
.... sourceAttachment Attachment
.... sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
.... source[x]:sourceReference Σ 0..1 Reference(Atrius India Core Consent(0.1.0) | Atrius India Core DocumentReference(0.1.0)) Source from which this consent is taken
... 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
.... 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 SΣ 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
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.0.1 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.0.1 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📍3.1.0 THO v7.2
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 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 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(canonical) = '#').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.meta, Consent.implicitRules, Consent.language, Consent.text, Consent.extension, Consent.extension:encounter, Consent.modifierExtension, Consent.identifier, Consent.status, Consent.scope, Consent.scope.extension, Consent.scope.coding, Consent.scope.coding.extension, Consent.scope.coding.system, Consent.scope.coding.version, Consent.scope.coding.code, Consent.scope.coding.display, Consent.scope.coding.userSelected, Consent.scope.text, Consent.category, Consent.category.extension, Consent.category.coding, Consent.category.coding:surgical, Consent.category.coding:surgical.extension, Consent.category.coding:surgical.system, Consent.category.coding:surgical.version, Consent.category.coding:surgical.code, Consent.category.coding:surgical.display, Consent.category.coding:surgical.userSelected, Consent.category.text, Consent.patient, Consent.dateTime, Consent.performer, Consent.organization, Consent.source[x], Consent.source[x]:sourceReference, Consent.policy, Consent.policy.extension, Consent.policy.modifierExtension, Consent.policy.authority, Consent.policy.uri, Consent.policyRule, 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.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:encounter, Consent.modifierExtension, Consent.scope.extension, Consent.scope.coding.extension, Consent.category.extension, Consent.category.coding:surgical.extension, Consent.policy.extension, Consent.policy.modifierExtension, Consent.verification.extension, Consent.verification.modifierExtension, Consent.provision.extension, 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()

Summary

Mandatory: 5 elements
Must-Support: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Consent.category.coding

 

Other representations of profile: CSV, Excel, Schematron