AU eRequesting Implementation Guide
0.3.0-preview - Preview

Publication Build: This will be filled in by the publication tooling

## Resource Profile: AU eRequesting MHR Consent Withdrawal

Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-mhrconsentwithdrawal | Version: 0.3.0-preview
Standards status: Draft | Maturity Level: 0 | Computable Name: AUeRequestingMHRConsentWithdrawal
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a Consent resource to record, search, and fetch a My Health Record (MHR) consent withdrawal. It is based on the Consent and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Consent when conforming to this profile.

Usage:

- CapabilityStatements using this Resource Profile: AU eRequesting Filler CapabilityStatement, AU eRequesting Patient CapabilityStatement, AU eRequesting Placer CapabilityStatement and AU eRequesting Server CapabilityStatement
- This Resource Profile is not used by any profiles in this Implementation Guide

### Formal Views of Profile Content

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

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

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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | ?!SO Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. ele-1: All FHIR elements must have a @value or children Fixed Value: active
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
scope | ?!SO Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding | Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy
category | SO Σ | 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. ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding | Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL
patient | SO Σ | 1..1 | Reference(AU Core Patient) | Who the consent applies to ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
dateTime | SO Σ | 1..1 | dateTime | When this Consent was created or indexed ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
performer | SO Σ | 1..1 | Reference(AU Core Patient) | Who is agreeing to the policy and rules ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
organization | SO Σ | 1..1 | Reference(AU Core Organization) | Custodian of the consent ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
policyRule | SO Σ C | 1..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding | Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OPTIN
provision | SO Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type | SO Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. ele-1: All FHIR elements must have a @value or children Fixed Value: deny
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
action | SO Σ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding | Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: disclose
Slices for class | SO Σ | 1..* | Coding | e.g. Resource Type, Profile, CDA, etc. Slice: Unordered, Open by pattern:$this Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
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. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DiagnosticReport
data | SO Σ | 1..* | BackboneElement | Data controlled by this rule ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning | SO Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Fixed Value: dependents
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
reference | SO Σ | 1..1 | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | The actual data reference ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Consent.status | required | Fixed Value: 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 | Fixed Value: 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 | Pattern: DiagnosticReport `http://hl7.org/fhir/ValueSet/consent-content-class` from the FHIR Standard
Consent.provision.data.meaning | required | Fixed Value: dependents `http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1` from the FHIR Standard

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 | SO | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Fixed Value: active
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
scope | SO | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible)
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding |  | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy
category | SO | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding |  | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL
patient | SO | 1..1 | Reference(AU Core Patient) | Who the consent applies to
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
dateTime | SO | 1..1 | dateTime | When this Consent was created or indexed
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
performer | SO | 1..1 | Reference(AU Core Patient) | Who is agreeing to the policy and rules
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
organization | SO | 1..1 | Reference(AU Core Organization) | Custodian of the consent
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
policyRule | SO | 1..1 | CodeableConcept | Regulation that this consents to
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding |  | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OPTIN
provision | SO | 1..1 | BackboneElement | Constraints to the base Consent.policyRule
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
type | SO | 1..1 | code | deny | permit Fixed Value: deny
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
action | SO | 1..1 | CodeableConcept | Actions controlled by this rule
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding |  | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: disclose
Slices for class | SO | 1..* | Coding | e.g. Resource Type, Profile, CDA, etc. Slice: Unordered, Open by pattern:$this
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
class:diagnosticReport | S | 1..1 | Coding | e.g. Resource Type, Profile, CDA, etc. Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DiagnosticReport
data | SO | 1..* | BackboneElement | Data controlled by this rule
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
meaning | SO | 1..1 | code | instance | related | dependents | authoredby Fixed Value: dependents
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
reference | SO | 1..1 | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | The actual data reference
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
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
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 | ?!SO Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
scope | ?!SO Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: 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 Fixed Value: 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 | SO Σ | 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.
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: 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 Fixed Value: 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 | SO Σ | 1..1 | Reference(AU Core Patient) | Who the consent applies to
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
dateTime | SO Σ | 1..1 | dateTime | When this Consent was created or indexed
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
performer | SO Σ | 1..1 | Reference(AU Core Patient) | Who is agreeing to the policy and rules
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
organization | SO Σ | 1..1 | Reference(AU Core Organization) | Custodian of the consent
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
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 | SO Σ C | 1..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: 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 Fixed Value: 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 | SO Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
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 | SO Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: deny
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
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 | SO Σ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: 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 Fixed Value: 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 | SO Σ | 1..* | Coding | e.g. Resource Type, Profile, CDA, etc. Slice: Unordered, Open by pattern:$this Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
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. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: 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 Fixed Value: 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 | SO Σ | 1..* | BackboneElement | Data controlled by this rule
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
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 | SO Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Fixed Value: dependents
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
reference | SO Σ | 1..1 | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | The actual data reference
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
provision |  | 0..* | See provision (Consent) | Nested Exception Rules
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Consent.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Consent.status | required | Fixed Value: 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 | Fixed Value: 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 | Pattern: DiagnosticReport `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 | Fixed Value: dependents `http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1` from the FHIR Standard

This structure is derived from Consent

Summary

Mandatory: 15 elements
Must-Support: 16 elements
Fixed: 3 elements

Structures

This structure refers to these other structures:

- AU Core Patient (http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient)
- AU Core Organization (http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization)
- AU eRequesting Pathology Request (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-path)
- AU eRequesting Imaging Request (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-imag)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Consent.provision.class

Maturity: 0

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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | ?!SO Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. ele-1: All FHIR elements must have a @value or children Fixed Value: active
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
scope | ?!SO Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding | Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy
category | SO Σ | 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. ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding | Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL
patient | SO Σ | 1..1 | Reference(AU Core Patient) | Who the consent applies to ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
dateTime | SO Σ | 1..1 | dateTime | When this Consent was created or indexed ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
performer | SO Σ | 1..1 | Reference(AU Core Patient) | Who is agreeing to the policy and rules ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
organization | SO Σ | 1..1 | Reference(AU Core Organization) | Custodian of the consent ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
policyRule | SO Σ C | 1..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding | Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OPTIN
provision | SO Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type | SO Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. ele-1: All FHIR elements must have a @value or children Fixed Value: deny
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
action | SO Σ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding | Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: disclose
Slices for class | SO Σ | 1..* | Coding | e.g. Resource Type, Profile, CDA, etc. Slice: Unordered, Open by pattern:$this Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
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. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DiagnosticReport
data | SO Σ | 1..* | BackboneElement | Data controlled by this rule ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning | SO Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Fixed Value: dependents
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
reference | SO Σ | 1..1 | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | The actual data reference ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Consent.status | required | Fixed Value: 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 | Fixed Value: 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 | Pattern: DiagnosticReport `http://hl7.org/fhir/ValueSet/consent-content-class` from the FHIR Standard
Consent.provision.data.meaning | required | Fixed Value: dependents `http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1` from the FHIR Standard

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 | SO | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Fixed Value: active
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
scope | SO | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible)
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding |  | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy
category | SO | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding |  | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL
patient | SO | 1..1 | Reference(AU Core Patient) | Who the consent applies to
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
dateTime | SO | 1..1 | dateTime | When this Consent was created or indexed
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
performer | SO | 1..1 | Reference(AU Core Patient) | Who is agreeing to the policy and rules
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
organization | SO | 1..1 | Reference(AU Core Organization) | Custodian of the consent
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
policyRule | SO | 1..1 | CodeableConcept | Regulation that this consents to
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding |  | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OPTIN
provision | SO | 1..1 | BackboneElement | Constraints to the base Consent.policyRule
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
type | SO | 1..1 | code | deny | permit Fixed Value: deny
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
action | SO | 1..1 | CodeableConcept | Actions controlled by this rule
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
coding |  | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentaction
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: disclose
Slices for class | SO | 1..* | Coding | e.g. Resource Type, Profile, CDA, etc. Slice: Unordered, Open by pattern:$this
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
class:diagnosticReport | S | 1..1 | Coding | e.g. Resource Type, Profile, CDA, etc. Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DiagnosticReport
data | SO | 1..* | BackboneElement | Data controlled by this rule
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
meaning | SO | 1..1 | code | instance | related | dependents | authoredby Fixed Value: dependents
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
reference | SO | 1..1 | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | The actual data reference
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
Documentation for this format

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 | ?!SO Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
scope | ?!SO Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: 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 Fixed Value: 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 | SO Σ | 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.
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: 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 Fixed Value: 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 | SO Σ | 1..1 | Reference(AU Core Patient) | Who the consent applies to
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
dateTime | SO Σ | 1..1 | dateTime | When this Consent was created or indexed
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
performer | SO Σ | 1..1 | Reference(AU Core Patient) | Who is agreeing to the policy and rules
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
organization | SO Σ | 1..1 | Reference(AU Core Organization) | Custodian of the consent
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
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 | SO Σ C | 1..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: 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 Fixed Value: 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 | SO Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
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 | SO Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: deny
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
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 | SO Σ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: 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 Fixed Value: 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 | SO Σ | 1..* | Coding | e.g. Resource Type, Profile, CDA, etc. Slice: Unordered, Open by pattern:$this Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
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. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: 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 Fixed Value: 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 | SO Σ | 1..* | BackboneElement | Data controlled by this rule
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
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 | SO Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Fixed Value: dependents
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
reference | SO Σ | 1..1 | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | The actual data reference
Obligations | Actor
SHALL:populate | AU eRequesting Placer
SHALL:handle | AU eRequesting Filler
SHALL:handle | AU eRequesting Server
SHALL:able-to-populate | AU eRequesting Server
SHALL:no-error | AU eRequesting Patient
provision |  | 0..* | See provision (Consent) | Nested Exception Rules
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Consent.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Consent.status | required | Fixed Value: 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 | Fixed Value: 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 | Pattern: DiagnosticReport `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 | Fixed Value: dependents `http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1` from the FHIR Standard

This structure is derived from Consent

Summary

Mandatory: 15 elements
Must-Support: 16 elements
Fixed: 3 elements

Structures

This structure refers to these other structures:

- AU Core Patient (http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient)
- AU Core Organization (http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization)
- AU eRequesting Pathology Request (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-path)
- AU eRequesting Imaging Request (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-imag)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Consent.provision.class

Maturity: 0

Other representations of profile: CSV, Excel, Schematron