AU eRequesting Implementation Guide
0.3.0-preview - Preview
AU eRequesting Implementation Guide
0.3.0-preview - Preview
This page is part of the AU eRequesting (v0.3.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| 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
| ||||||||||||
 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
| ||||||||||||
  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
| ||||||||||||
| 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
| ||||||||||||
| dateTime |
SOΣ | 1..1 | dateTime | When this Consent was created or indexed ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| 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
| ||||||||||||
| organization |
SOΣ | 1..1 | Reference(AU Core Organization) | Custodian of the consent ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| 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
| ||||||||||||
| 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
| ||||||||||||
| 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
| ||||||||||||
| 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
| ||||||||||||
| 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
| ||||||||||||
  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
| ||||||||||||
| 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
| ||||||||||||
| 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
| ||||||||||||
| 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: 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 |
Other representations of profile: CSV, Excel, Schematron
IG © 2025 HL7 Australia. Package hl7.fhir.au.ereq#0.3.0-preview based on FHIR 4.0.1. Generated 2025-03-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
