Magentus Practice Management FHIR Implementation Guide
1.2.16 - ci-build

Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.16) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: EOrders Consent Withdrawl

Official URL: http://fhir.geniesolutions.io/StructureDefinition/eorders-consentwithdrawl | Version: 1.2.16
Draft as of 2024-08-15 | Computable Name: EOrdersConsentWithdrawl

EOrders Withdraw Consent to upload result to MHR

Usage:

- Examples for this Resource Profile: Consent/6d83978c-6507-4c1a-8099-4a7d7fe48bc0 and Consent/880c657d-af10-4a4c-a925-dbd49075f0eb

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Consent

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Consent |  | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
status | S | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Required Pattern: active
scope |  |  |  |
Slices for coding |  | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:patientprivacy | S | 0..1 | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
code |  | 1..1 | code | Symbol in syntax defined by the system Required Pattern: patient-privacy
category |  |  |  |
Slices for coding |  | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:idscl | S | 0..1 | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
code |  | 1..1 | code | Symbol in syntax defined by the system Required Pattern: IDSCL
patient | S | 1..1 | Reference(Genie Patient) | Who the consent applies to
dateTime | S | 1..1 | dateTime | When this Consent was created or indexed
performer | S | 0..1 | Reference(AU Base Related Person | Genie Patient) | Who is agreeing to the policy and rules
organization | S | 1..1 | Reference(Genie Organization) | Custodian of the consent
policyRule |  |  |  |
Slices for coding |  | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:optin | S | 0..1 | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
code |  | 1..1 | code | Symbol in syntax defined by the system Required Pattern: OPTIN
provision | S | 1..1 | BackboneElement | Constraints to the base Consent.policyRule
type | S | 1..1 | code | deny | permit Required Pattern: deny
action | S | 1..1 | CodeableConcept | Actions controlled by this rule
Slices for coding |  | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:disclose | S | 0..1 | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentaction
code |  | 1..1 | code | Symbol in syntax defined by the system Required Pattern: disclose
Slices for class | S | 1..* | Coding | e.g. Resource Type, Profile, CDA, etc. Slice: Unordered, Open by value:system, value:code
class:diagnosticreport | S | 1..1 | Coding | e.g. Resource Type, Profile, CDA, etc.
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/resource-types
code |  | 1..1 | code | Symbol in syntax defined by the system Required Pattern: DiagnosticReport
data | S | 1..* | BackboneElement | Data controlled by this rule
meaning | S | 1..1 | code | instance | related | dependents | authoredby Required Pattern: dependents
reference | S | 1..1 | Reference(EOrders Diagnostic Request) | Reference to dependent ServiceRequest(s). (See description for unresolved problem)
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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 | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:patientprivacy | S Σ | 0..1 | Coding | Code defined by a terminology system
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: patient-privacy
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.
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:idscl | S Σ | 0..1 | Coding | Code defined by a terminology system
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: IDSCL
patient | S Σ | 1..1 | Reference(Genie Patient) | Who the consent applies to
dateTime | S Σ | 1..1 | dateTime | When this Consent was created or indexed
performer | S Σ | 0..1 | Reference(AU Base Related Person | Genie Patient) | Who is agreeing to the policy and rules
organization | S Σ | 1..1 | Reference(Genie Organization) | Custodian of the consent
policyRule | Σ C | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:optin | S Σ | 0..1 | Coding | Code defined by a terminology system
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: OPTIN
provision | S Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Required Pattern: deny
action | S Σ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:disclose | S Σ | 0..1 | Coding | Code defined by a terminology system
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentaction
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: disclose
Slices for class | S Σ | 1..* | Coding | e.g. Resource Type, Profile, CDA, etc. Slice: Unordered, Open by value:system, value:code Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
class:diagnosticreport | S Σ | 1..1 | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/resource-types
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: DiagnosticReport
data | S Σ | 1..* | BackboneElement | Data controlled by this rule
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
meaning | S Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: dependents
reference | S Σ | 1..1 | Reference(EOrders Diagnostic Request) | Reference to dependent ServiceRequest(s). (See description for unresolved problem)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Consent.status | required | Pattern: active `http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1` from the FHIR Standard
Consent.scope | extensible | ConsentScopeCodes `http://hl7.org/fhir/ValueSet/consent-scope` from the FHIR Standard
Consent.category | extensible | ConsentCategoryCodes `http://hl7.org/fhir/ValueSet/consent-category` from the FHIR Standard
Consent.policyRule | extensible | ConsentPolicyRuleCodes `http://hl7.org/fhir/ValueSet/consent-policy` from the FHIR Standard
Consent.provision.type | required | Pattern: deny `http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1` from the FHIR Standard
Consent.provision.action | example | ConsentActionCodes `http://hl7.org/fhir/ValueSet/consent-action` from the FHIR Standard
Consent.provision.class | extensible | ConsentContentClass `http://hl7.org/fhir/ValueSet/consent-content-class` from the FHIR Standard
Consent.provision.class:diagnosticreport | extensible | ConsentContentClass `http://hl7.org/fhir/ValueSet/consent-content-class` from the FHIR Standard
Consent.provision.data.meaning | required | Pattern: dependents `http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() |
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() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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 | ?!Σ | 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
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:patientprivacy | S Σ | 0..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
system | Σ | 1..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 | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: patient-privacy
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 | Σ | 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
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:idscl | S Σ | 0..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
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: IDSCL
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(Genie Patient) | Who the consent applies to
dateTime | S Σ | 1..1 | dateTime | When this Consent was created or indexed
performer | S Σ | 0..1 | Reference(AU Base Related Person | Genie Patient) | Who is agreeing to the policy and rules
organization | S Σ | 1..1 | Reference(Genie Organization) | Custodian of the consent
source[x] | Σ | 0..1 |  | Source from which this consent is taken
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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
authority | C | 0..1 | uri | Enforcement source for policy
uri | C | 0..1 | uri | Specific policy covered by this consent
policyRule | Σ C | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:optin | S Σ | 0..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
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: OPTIN
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
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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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 Σ | 1..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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Required Pattern: deny
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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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 | S Σ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:disclose | S Σ | 0..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
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentaction
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: disclose
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
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 (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
Slices for class | S Σ | 1..* | Coding | e.g. Resource Type, Profile, CDA, etc. Slice: Unordered, Open by value:system, value:code Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
class:diagnosticreport | S Σ | 1..1 | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/resource-types
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: DiagnosticReport
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
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 | S Σ | 1..* | BackboneElement | Data controlled by this rule
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
meaning | S Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: dependents
reference | S Σ | 1..1 | Reference(EOrders Diagnostic Request) | Reference to dependent ServiceRequest(s). (See description for unresolved problem)
provision |  | 0..* | See provision (Consent) | Nested Exception Rules
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Consent.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Consent.status | required | Pattern: active `http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1` from the FHIR Standard
Consent.scope | extensible | ConsentScopeCodes `http://hl7.org/fhir/ValueSet/consent-scope` from the FHIR Standard
Consent.category | extensible | ConsentCategoryCodes `http://hl7.org/fhir/ValueSet/consent-category` from the FHIR Standard
Consent.policyRule | extensible | ConsentPolicyRuleCodes `http://hl7.org/fhir/ValueSet/consent-policy` from the FHIR Standard
Consent.provision.type | required | Pattern: deny `http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1` from the FHIR Standard
Consent.provision.actor.role | extensible | SecurityRoleType `http://hl7.org/fhir/ValueSet/security-role-type` from the FHIR Standard
Consent.provision.action | example | ConsentActionCodes `http://hl7.org/fhir/ValueSet/consent-action` from the FHIR Standard
Consent.provision.securityLabel | extensible | All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` from the FHIR Standard
Consent.provision.purpose | extensible | PurposeOfUse `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse`
Consent.provision.class | extensible | ConsentContentClass `http://hl7.org/fhir/ValueSet/consent-content-class` from the FHIR Standard
Consent.provision.class:diagnosticreport | extensible | ConsentContentClass `http://hl7.org/fhir/ValueSet/consent-content-class` from the FHIR Standard
Consent.provision.code | example | ConsentContentCodes (a valid code from LOINC) `http://hl7.org/fhir/ValueSet/consent-content-code` from the FHIR Standard
Consent.provision.data.meaning | required | Pattern: dependents `http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() |
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

Mandatory: 11 elements(8 nested mandatory elements)
Must-Support: 17 elements

Structures

This structure refers to these other structures:

- Genie Patient (http://fhir.geniesolutions.io/StructureDefinition/gs-patient)
- AU Base Related Person (http://hl7.org.au/fhir/StructureDefinition/au-relatedperson)
- Genie Organization (http://fhir.geniesolutions.io/StructureDefinition/gs-organization)
- EOrders Diagnostic Request (http://fhir.geniesolutions.io/StructureDefinition/eorders-diagnosticrequest)

Slices

This structure defines the following Slices:

- The element 2 is sliced based on the values of Consent.scope.coding
- The element 2 is sliced based on the values of Consent.category.coding
- The element 2 is sliced based on the values of Consent.policyRule.coding
- The element 2 is sliced based on the values of Consent.provision.action.coding
- The element 2 is sliced based on the values of Consent.provision.class

Differential View

This structure is derived from Consent

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Consent |  | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
status | S | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Required Pattern: active
scope |  |  |  |
Slices for coding |  | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:patientprivacy | S | 0..1 | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
code |  | 1..1 | code | Symbol in syntax defined by the system Required Pattern: patient-privacy
category |  |  |  |
Slices for coding |  | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:idscl | S | 0..1 | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
code |  | 1..1 | code | Symbol in syntax defined by the system Required Pattern: IDSCL
patient | S | 1..1 | Reference(Genie Patient) | Who the consent applies to
dateTime | S | 1..1 | dateTime | When this Consent was created or indexed
performer | S | 0..1 | Reference(AU Base Related Person | Genie Patient) | Who is agreeing to the policy and rules
organization | S | 1..1 | Reference(Genie Organization) | Custodian of the consent
policyRule |  |  |  |
Slices for coding |  | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:optin | S | 0..1 | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
code |  | 1..1 | code | Symbol in syntax defined by the system Required Pattern: OPTIN
provision | S | 1..1 | BackboneElement | Constraints to the base Consent.policyRule
type | S | 1..1 | code | deny | permit Required Pattern: deny
action | S | 1..1 | CodeableConcept | Actions controlled by this rule
Slices for coding |  | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:disclose | S | 0..1 | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentaction
code |  | 1..1 | code | Symbol in syntax defined by the system Required Pattern: disclose
Slices for class | S | 1..* | Coding | e.g. Resource Type, Profile, CDA, etc. Slice: Unordered, Open by value:system, value:code
class:diagnosticreport | S | 1..1 | Coding | e.g. Resource Type, Profile, CDA, etc.
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/resource-types
code |  | 1..1 | code | Symbol in syntax defined by the system Required Pattern: DiagnosticReport
data | S | 1..* | BackboneElement | Data controlled by this rule
meaning | S | 1..1 | code | instance | related | dependents | authoredby Required Pattern: dependents
reference | S | 1..1 | Reference(EOrders Diagnostic Request) | Reference to dependent ServiceRequest(s). (See description for unresolved problem)
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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 | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:patientprivacy | S Σ | 0..1 | Coding | Code defined by a terminology system
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: patient-privacy
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.
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:idscl | S Σ | 0..1 | Coding | Code defined by a terminology system
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: IDSCL
patient | S Σ | 1..1 | Reference(Genie Patient) | Who the consent applies to
dateTime | S Σ | 1..1 | dateTime | When this Consent was created or indexed
performer | S Σ | 0..1 | Reference(AU Base Related Person | Genie Patient) | Who is agreeing to the policy and rules
organization | S Σ | 1..1 | Reference(Genie Organization) | Custodian of the consent
policyRule | Σ C | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:optin | S Σ | 0..1 | Coding | Code defined by a terminology system
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: OPTIN
provision | S Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Required Pattern: deny
action | S Σ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:disclose | S Σ | 0..1 | Coding | Code defined by a terminology system
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentaction
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: disclose
Slices for class | S Σ | 1..* | Coding | e.g. Resource Type, Profile, CDA, etc. Slice: Unordered, Open by value:system, value:code Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
class:diagnosticreport | S Σ | 1..1 | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/resource-types
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: DiagnosticReport
data | S Σ | 1..* | BackboneElement | Data controlled by this rule
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
meaning | S Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: dependents
reference | S Σ | 1..1 | Reference(EOrders Diagnostic Request) | Reference to dependent ServiceRequest(s). (See description for unresolved problem)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Consent.status | required | Pattern: active `http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1` from the FHIR Standard
Consent.scope | extensible | ConsentScopeCodes `http://hl7.org/fhir/ValueSet/consent-scope` from the FHIR Standard
Consent.category | extensible | ConsentCategoryCodes `http://hl7.org/fhir/ValueSet/consent-category` from the FHIR Standard
Consent.policyRule | extensible | ConsentPolicyRuleCodes `http://hl7.org/fhir/ValueSet/consent-policy` from the FHIR Standard
Consent.provision.type | required | Pattern: deny `http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1` from the FHIR Standard
Consent.provision.action | example | ConsentActionCodes `http://hl7.org/fhir/ValueSet/consent-action` from the FHIR Standard
Consent.provision.class | extensible | ConsentContentClass `http://hl7.org/fhir/ValueSet/consent-content-class` from the FHIR Standard
Consent.provision.class:diagnosticreport | extensible | ConsentContentClass `http://hl7.org/fhir/ValueSet/consent-content-class` from the FHIR Standard
Consent.provision.data.meaning | required | Pattern: dependents `http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() |
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() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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 | ?!Σ | 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
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:patientprivacy | S Σ | 0..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
system | Σ | 1..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 | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: patient-privacy
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 | Σ | 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
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:idscl | S Σ | 0..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
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: IDSCL
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(Genie Patient) | Who the consent applies to
dateTime | S Σ | 1..1 | dateTime | When this Consent was created or indexed
performer | S Σ | 0..1 | Reference(AU Base Related Person | Genie Patient) | Who is agreeing to the policy and rules
organization | S Σ | 1..1 | Reference(Genie Organization) | Custodian of the consent
source[x] | Σ | 0..1 |  | Source from which this consent is taken
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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
authority | C | 0..1 | uri | Enforcement source for policy
uri | C | 0..1 | uri | Specific policy covered by this consent
policyRule | Σ C | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:optin | S Σ | 0..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
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: OPTIN
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
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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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 Σ | 1..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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Required Pattern: deny
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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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 | S Σ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code
coding:disclose | S Σ | 0..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
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentaction
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: disclose
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
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 (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
Slices for class | S Σ | 1..* | Coding | e.g. Resource Type, Profile, CDA, etc. Slice: Unordered, Open by value:system, value:code Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
class:diagnosticreport | S Σ | 1..1 | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/resource-types
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: DiagnosticReport
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
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 | S Σ | 1..* | BackboneElement | Data controlled by this rule
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
meaning | S Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: dependents
reference | S Σ | 1..1 | Reference(EOrders Diagnostic Request) | Reference to dependent ServiceRequest(s). (See description for unresolved problem)
provision |  | 0..* | See provision (Consent) | Nested Exception Rules
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Consent.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Consent.status | required | Pattern: active `http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1` from the FHIR Standard
Consent.scope | extensible | ConsentScopeCodes `http://hl7.org/fhir/ValueSet/consent-scope` from the FHIR Standard
Consent.category | extensible | ConsentCategoryCodes `http://hl7.org/fhir/ValueSet/consent-category` from the FHIR Standard
Consent.policyRule | extensible | ConsentPolicyRuleCodes `http://hl7.org/fhir/ValueSet/consent-policy` from the FHIR Standard
Consent.provision.type | required | Pattern: deny `http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1` from the FHIR Standard
Consent.provision.actor.role | extensible | SecurityRoleType `http://hl7.org/fhir/ValueSet/security-role-type` from the FHIR Standard
Consent.provision.action | example | ConsentActionCodes `http://hl7.org/fhir/ValueSet/consent-action` from the FHIR Standard
Consent.provision.securityLabel | extensible | All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` from the FHIR Standard
Consent.provision.purpose | extensible | PurposeOfUse `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse`
Consent.provision.class | extensible | ConsentContentClass `http://hl7.org/fhir/ValueSet/consent-content-class` from the FHIR Standard
Consent.provision.class:diagnosticreport | extensible | ConsentContentClass `http://hl7.org/fhir/ValueSet/consent-content-class` from the FHIR Standard
Consent.provision.code | example | ConsentContentCodes (a valid code from LOINC) `http://hl7.org/fhir/ValueSet/consent-content-code` from the FHIR Standard
Consent.provision.data.meaning | required | Pattern: dependents `http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() |
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

Mandatory: 11 elements(8 nested mandatory elements)
Must-Support: 17 elements

Structures

This structure refers to these other structures:

- Genie Patient (http://fhir.geniesolutions.io/StructureDefinition/gs-patient)
- AU Base Related Person (http://hl7.org.au/fhir/StructureDefinition/au-relatedperson)
- Genie Organization (http://fhir.geniesolutions.io/StructureDefinition/gs-organization)
- EOrders Diagnostic Request (http://fhir.geniesolutions.io/StructureDefinition/eorders-diagnosticrequest)

Slices

This structure defines the following Slices:

- The element 2 is sliced based on the values of Consent.scope.coding
- The element 2 is sliced based on the values of Consent.category.coding
- The element 2 is sliced based on the values of Consent.policyRule.coding
- The element 2 is sliced based on the values of Consent.provision.action.coding
- The element 2 is sliced based on the values of Consent.provision.class

Other representations of profile: CSV, Excel, Schematron