AU eRequesting Implementation Guide
0.3.0-ci-build - CI Build
AU eRequesting Implementation Guide
0.3.0-ci-build - CI Build
AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.3.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/mjosborne1/mjo-au-fhir-erequesting/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-mhrconsentwithdrawal | Version: 0.3.0-ci-build | |||
| 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.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  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
| ||||||||||||
| scope |
SO | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible)
| ||||||||||||
  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
| ||||||||||||
| 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
| ||||||||||||
| dateTime |
SO | 1..1 | dateTime | When this Consent was created or indexed
| ||||||||||||
| performer |
SO | 1..1 | Reference(AU Core Patient) | Who is agreeing to the policy and rules
| ||||||||||||
| organization |
SO | 1..1 | Reference(AU Core Organization) | Custodian of the consent
| ||||||||||||
| policyRule |
SO | 1..1 | CodeableConcept | Regulation that this consents to
| ||||||||||||
| 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
| ||||||||||||
| type |
SO | 1..1 | code | deny | permit Fixed Value: deny
| ||||||||||||
| action |
SO | 1..1 | CodeableConcept | Actions controlled by this rule
| ||||||||||||
| 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
| ||||||||||||
  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
| ||||||||||||
| meaning |
SO | 1..1 | code | instance | related | dependents | authoredby Fixed Value: dependents
| ||||||||||||
| reference |
SO | 1..1 | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | The actual data reference
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 | |||||||||||||||||
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||
| 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
| |||||||||||||||||
 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.
| |||||||||||||||||
| 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 | ||||||||||||||||||
| 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.
| |||||||||||||||||
| 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 | ||||||||||||||||||
| patient |
SOΣ | 1..1 | Reference(AU Core Patient) | Who the consent applies to
| |||||||||||||||||
| dateTime |
SOΣ | 1..1 | dateTime | When this Consent was created or indexed
| |||||||||||||||||
| performer |
SOΣ | 1..1 | Reference(AU Core Patient) | Who is agreeing to the policy and rules
| |||||||||||||||||
| organization |
SOΣ | 1..1 | Reference(AU Core Organization) | Custodian of the consent
| |||||||||||||||||
| policyRule |
SOΣC | 1..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
| |||||||||||||||||
| 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 | ||||||||||||||||||
| provision |
SOΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule
| |||||||||||||||||
| 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
| |||||||||||||||||
| action |
SOΣ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
| |||||||||||||||||
| 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 | ||||||||||||||||||
| 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.
| |||||||||||||||||
| 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 | ||||||||||||||||||
| data |
SOΣ | 1..* | BackboneElement | Data controlled by this rule
| |||||||||||||||||
| 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
| |||||||||||||||||
| reference |
SOΣ | 1..1 | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | The actual data reference
| |||||||||||||||||
| Documentation for this format | |||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1From the FHIR Standard | |
| Consent.scope | extensible | ConsentScopeCodeshttp://hl7.org/fhir/ValueSet/consent-scopeFrom the FHIR Standard | |
| Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-categoryFrom the FHIR Standard | |
| Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policyFrom the FHIR Standard | |
| Consent.provision.type | required | Fixed Value: denyhttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1From the FHIR Standard | |
| Consent.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-actionFrom the FHIR Standard | |
| Consent.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classFrom the FHIR Standard | |
| Consent.provision.class:diagnosticReport | extensible | Pattern Value: DiagnosticReporthttp://hl7.org/fhir/ValueSet/consent-content-classFrom the FHIR Standard | |
| Consent.provision.data.meaning | required | Fixed Value: dependentshttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1From the FHIR Standard |
| 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 Filter: | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 | |||||||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | |||||||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | |||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||
| 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
| |||||||||||||||||
| 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.
| |||||||||||||||||
| 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.
| |||||||||||||||||
| 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
| |||||||||||||||||
| dateTime |
SOΣ | 1..1 | dateTime | When this Consent was created or indexed
| |||||||||||||||||
| performer |
SOΣ | 1..1 | Reference(AU Core Patient) | Who is agreeing to the policy and rules
| |||||||||||||||||
| organization |
SOΣ | 1..1 | Reference(AU Core 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 |
SOΣC | 1..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 | ||||||||||||||||||
| 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
| |||||||||||||||||
| 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
| |||||||||||||||||
| 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.
| |||||||||||||||||
| 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.
| |||||||||||||||||
| 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
| |||||||||||||||||
| 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
| |||||||||||||||||
| reference |
SOΣ | 1..1 | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | The actual data reference
| |||||||||||||||||
| provision |
0..* | See provision (Consent) | Nested Exception Rules | ||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Consent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1From the FHIR Standard | ||||
| Consent.scope | extensible | ConsentScopeCodeshttp://hl7.org/fhir/ValueSet/consent-scopeFrom the FHIR Standard | ||||
| Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-categoryFrom the FHIR Standard | ||||
| Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policyFrom the FHIR Standard | ||||
| Consent.provision.type | required | Fixed Value: denyhttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1From the FHIR Standard | ||||
| Consent.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typeFrom the FHIR Standard | ||||
| Consent.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-actionFrom the FHIR Standard | ||||
| Consent.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Consent.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classFrom the FHIR Standard | ||||
| Consent.provision.class:diagnosticReport | extensible | Pattern Value: DiagnosticReporthttp://hl7.org/fhir/ValueSet/consent-content-classFrom the FHIR Standard | ||||
| Consent.provision.code | example | ConsentContentCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-codeFrom the FHIR Standard | ||||
| Consent.provision.data.meaning | required | Fixed Value: dependentshttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1From the FHIR Standard |
| 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: 15 elements
Must-Support: 16 elements
Fixed: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Differential View
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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
| ||||||||||||
| scope |
SO | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible)
| ||||||||||||
| 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
| ||||||||||||
| 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
| ||||||||||||
| dateTime |
SO | 1..1 | dateTime | When this Consent was created or indexed
| ||||||||||||
| performer |
SO | 1..1 | Reference(AU Core Patient) | Who is agreeing to the policy and rules
| ||||||||||||
| organization |
SO | 1..1 | Reference(AU Core Organization) | Custodian of the consent
| ||||||||||||
| policyRule |
SO | 1..1 | CodeableConcept | Regulation that this consents to
| ||||||||||||
| 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
| ||||||||||||
| type |
SO | 1..1 | code | deny | permit Fixed Value: deny
| ||||||||||||
| action |
SO | 1..1 | CodeableConcept | Actions controlled by this rule
| ||||||||||||
| 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
| ||||||||||||
| 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
| ||||||||||||
| meaning |
SO | 1..1 | code | instance | related | dependents | authoredby Fixed Value: dependents
| ||||||||||||
| reference |
SO | 1..1 | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | The actual data reference
| ||||||||||||
| Documentation for this format | ||||||||||||||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 | |||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||
| 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
| |||||||||||||||||
| 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.
| |||||||||||||||||
| 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 | ||||||||||||||||||
| 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.
| |||||||||||||||||
| 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 | ||||||||||||||||||
| patient |
SOΣ | 1..1 | Reference(AU Core Patient) | Who the consent applies to
| |||||||||||||||||
| dateTime |
SOΣ | 1..1 | dateTime | When this Consent was created or indexed
| |||||||||||||||||
| performer |
SOΣ | 1..1 | Reference(AU Core Patient) | Who is agreeing to the policy and rules
| |||||||||||||||||
| organization |
SOΣ | 1..1 | Reference(AU Core Organization) | Custodian of the consent
| |||||||||||||||||
| policyRule |
SOΣC | 1..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
| |||||||||||||||||
| 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 | ||||||||||||||||||
| provision |
SOΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule
| |||||||||||||||||
| 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
| |||||||||||||||||
| action |
SOΣ | 1..1 | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
| |||||||||||||||||
| 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 | ||||||||||||||||||
| 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.
| |||||||||||||||||
| 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 | ||||||||||||||||||
| data |
SOΣ | 1..* | BackboneElement | Data controlled by this rule
| |||||||||||||||||
| 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
| |||||||||||||||||
| reference |
SOΣ | 1..1 | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | The actual data reference
| |||||||||||||||||
| Documentation for this format | |||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1From the FHIR Standard | |
| Consent.scope | extensible | ConsentScopeCodeshttp://hl7.org/fhir/ValueSet/consent-scopeFrom the FHIR Standard | |
| Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-categoryFrom the FHIR Standard | |
| Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policyFrom the FHIR Standard | |
| Consent.provision.type | required | Fixed Value: denyhttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1From the FHIR Standard | |
| Consent.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-actionFrom the FHIR Standard | |
| Consent.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classFrom the FHIR Standard | |
| Consent.provision.class:diagnosticReport | extensible | Pattern Value: DiagnosticReporthttp://hl7.org/fhir/ValueSet/consent-content-classFrom the FHIR Standard | |
| Consent.provision.data.meaning | required | Fixed Value: dependentshttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1From the FHIR Standard |
| 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 Filter: | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 | |||||||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | |||||||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | |||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||
| 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
| |||||||||||||||||
| 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.
| |||||||||||||||||
| 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.
| |||||||||||||||||
| 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
| |||||||||||||||||
| dateTime |
SOΣ | 1..1 | dateTime | When this Consent was created or indexed
| |||||||||||||||||
| performer |
SOΣ | 1..1 | Reference(AU Core Patient) | Who is agreeing to the policy and rules
| |||||||||||||||||
| organization |
SOΣ | 1..1 | Reference(AU Core 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 |
SOΣC | 1..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 | ||||||||||||||||||
| 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
| |||||||||||||||||
| 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
| |||||||||||||||||
| 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.
| |||||||||||||||||
| 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.
| |||||||||||||||||
| 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
| |||||||||||||||||
| 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
| |||||||||||||||||
| reference |
SOΣ | 1..1 | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request) | The actual data reference
| |||||||||||||||||
| provision |
0..* | See provision (Consent) | Nested Exception Rules | ||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Consent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1From the FHIR Standard | ||||
| Consent.scope | extensible | ConsentScopeCodeshttp://hl7.org/fhir/ValueSet/consent-scopeFrom the FHIR Standard | ||||
| Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-categoryFrom the FHIR Standard | ||||
| Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policyFrom the FHIR Standard | ||||
| Consent.provision.type | required | Fixed Value: denyhttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1From the FHIR Standard | ||||
| Consent.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typeFrom the FHIR Standard | ||||
| Consent.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-actionFrom the FHIR Standard | ||||
| Consent.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Consent.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classFrom the FHIR Standard | ||||
| Consent.provision.class:diagnosticReport | extensible | Pattern Value: DiagnosticReporthttp://hl7.org/fhir/ValueSet/consent-content-classFrom the FHIR Standard | ||||
| Consent.provision.code | example | ConsentContentCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-codeFrom the FHIR Standard | ||||
| Consent.provision.data.meaning | required | Fixed Value: dependentshttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1From the FHIR Standard |
| 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: 15 elements
Must-Support: 16 elements
Fixed: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU eRequesting CapabilityStatements for a complete list of supported RESTful interactions for this IG.
FHIR search operations are described here and the syntax used to describe AU eRequesting interactions is defined here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”.
| Parameter(s) | Server Conformance | Placer Conformance | Filler Conformance | Patient Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|---|---|---|
| _id | SHALL | MAY | MAY | MAY | token |
The following search parameters and search parameter combinations are supported. Conformance obligations are detailed in the table above.
_id search parameter
GET [base]/Consent?_id=[id]
Example:
Implementation Notes: Fetches a bundle with the requested Consent, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)
IG © 2024 HL7 Australia. Package hl7.fhir.au.ereq#0.3.0-ci-build based on FHIR 4.0.1. Generated 2025-06-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change