Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft Australia flag

Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA Record of Australian Organ Donor Register Consent

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-consent-aodr-1 Version: 1.0.1
Active as of 2024-09-12 Computable Name: ADHAConsentAODR

Copyright/Legal: Copyright © 2023 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

This resource includes SNOMED Clinical Terms™ (SNOMED CT®) which is used by permission of the International Health Terminology Standards Development Organisation (IHTSDO). All rights reserved. SNOMED CT®, was originally created by The College of American Pathologists. “SNOMED” and “SNOMED CT” are registered trademarks of the IHTSDO. The rights to use and implement or implementation of SNOMED CT content are limited to the extent it is necessary to allow for the end use of this material. No further rights are granted in respect of the International Release and no further use of any SNOMED CT content by any other party is permitted.

This material contains content from LOINC (http://loinc.org). LOINC is copyright © 1995-2021, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://loinc.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.

All copies of this resource must include this copyright statement and all information contained in this statement.

The purpose of this profile is to define a representation of a record of organ and tissue donation decision held by the Australian Organ Donor Register for the electronic exchange of digital health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile identifies the additional constraints, extensions, and value sets that build on and extend Consent that are supported.

This profile is designed to set a Consent standard for:

  • Query for a record of consent from the Australian Organ Donor Register associated with a patient
  • Record or update a record of consent from the Australian Organ Donor Register associated with a patient

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

  • An individual's decision not to be a donor is represented as Consent.provision.type = "deny", see example Australian Organ Donor Register Consent - Not willing to be a donor.
  • An individual's decision to be a donor is represented as Consent.provision.type = "permit" and the resource SHALL include the full set of child provisions representing the individual's decision with respect to each potential organ and/or tissue for transplantation:
  • In an exchange with the My Health Record system references to a BodyStructure resource will be contained.

Usage:

Formal Views of Profile Content

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

This structure is derived from Consent

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-cons-aodr-01errorConsent.patientAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-cons-aodr-02errorConsent.provisionSpecific provisions shall be specified if the individual is willing to donate, otherwise prohibited
: provision.exists() xor (type='deny')
inv-dh-cons-aodr-03errorConsent.dateTimeDate shall be at least to day
: toString().length() >= 10
inv-dh-cons-aodr-04errorConsent.performerAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-cons-aodr-05errorConsent.organizationAt least reference or display or a valid identifier shall be present
: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists()

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1
from the FHIR Standard
Consent.scopeextensiblePattern: adr
http://hl7.org/fhir/ValueSet/consent-scope
from the FHIR Standard
Consent.categoryextensibleConsentCategoryCodes
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:healthextensiblePattern: LOINC Code 59284-0
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:aodrextensiblePattern: LOINC Code 64300-7
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.provision.typerequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1
from the FHIR Standard
Consent.provision.actionexamplePattern: SNOMED-CT Code 53958007
http://hl7.org/fhir/ValueSet/consent-action
from the FHIR Standard
Consent.provision.provision.typerequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1
from the FHIR Standard
Consent.provision.provision.actionexamplePattern: SNOMED-CT Code 53958007
http://hl7.org/fhir/ValueSet/consent-action
from the FHIR Standard
Consent.provision.provision.data.meaningrequiredFixed Value: instance
http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-cons-aodr-01errorConsent.patientAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-cons-aodr-02errorConsent.provisionSpecific provisions shall be specified if the individual is willing to donate, otherwise prohibited
: provision.exists() xor (type='deny')
inv-dh-cons-aodr-03errorConsent.dateTimeDate shall be at least to day
: toString().length() >= 10
inv-dh-cons-aodr-04errorConsent.performerAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-cons-aodr-05errorConsent.organizationAt least reference or display or a valid identifier shall be present
: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists()

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Consent.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1
from the FHIR Standard
Consent.scopeextensiblePattern: adr
http://hl7.org/fhir/ValueSet/consent-scope
from the FHIR Standard
Consent.categoryextensibleConsentCategoryCodes
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:healthextensiblePattern: LOINC Code 59284-0
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:aodrextensiblePattern: LOINC Code 64300-7
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.policyRuleextensibleConsentPolicyRuleCodes
http://hl7.org/fhir/ValueSet/consent-policy
from the FHIR Standard
Consent.provision.typerequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1
from the FHIR Standard
Consent.provision.actor.roleextensibleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Consent.provision.actionexamplePattern: SNOMED-CT Code 53958007
http://hl7.org/fhir/ValueSet/consent-action
from the FHIR Standard
Consent.provision.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Consent.provision.purposeextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.classextensibleConsentContentClass
http://hl7.org/fhir/ValueSet/consent-content-class
from the FHIR Standard
Consent.provision.codeexampleConsentContentCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/consent-content-code
from the FHIR Standard
Consent.provision.data.meaningrequiredConsentDataMeaning
http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1
from the FHIR Standard
Consent.provision.provision.typerequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1
from the FHIR Standard
Consent.provision.provision.actor.roleextensibleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Consent.provision.provision.actionexamplePattern: SNOMED-CT Code 53958007
http://hl7.org/fhir/ValueSet/consent-action
from the FHIR Standard
Consent.provision.provision.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Consent.provision.provision.purposeextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.provision.classextensibleConsentContentClass
http://hl7.org/fhir/ValueSet/consent-content-class
from the FHIR Standard
Consent.provision.provision.codeexampleConsentContentCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/consent-content-code
from the FHIR Standard
Consent.provision.provision.data.meaningrequiredFixed Value: instance
http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1
from the FHIR Standard
Consent.provision.provision.data.reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-cons-aodr-01errorConsent.patientAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-cons-aodr-02errorConsent.provisionSpecific provisions shall be specified if the individual is willing to donate, otherwise prohibited
: provision.exists() xor (type='deny')
inv-dh-cons-aodr-03errorConsent.dateTimeDate shall be at least to day
: toString().length() >= 10
inv-dh-cons-aodr-04errorConsent.performerAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-cons-aodr-05errorConsent.organizationAt least reference or display or a valid identifier shall be present
: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists()

This structure is derived from Consent

Summary

Mandatory: 13 elements(4 nested mandatory elements)
Must-Support: 20 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Consent

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-cons-aodr-01errorConsent.patientAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-cons-aodr-02errorConsent.provisionSpecific provisions shall be specified if the individual is willing to donate, otherwise prohibited
: provision.exists() xor (type='deny')
inv-dh-cons-aodr-03errorConsent.dateTimeDate shall be at least to day
: toString().length() >= 10
inv-dh-cons-aodr-04errorConsent.performerAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-cons-aodr-05errorConsent.organizationAt least reference or display or a valid identifier shall be present
: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists()

Key Elements View

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1
from the FHIR Standard
Consent.scopeextensiblePattern: adr
http://hl7.org/fhir/ValueSet/consent-scope
from the FHIR Standard
Consent.categoryextensibleConsentCategoryCodes
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:healthextensiblePattern: LOINC Code 59284-0
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:aodrextensiblePattern: LOINC Code 64300-7
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.provision.typerequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1
from the FHIR Standard
Consent.provision.actionexamplePattern: SNOMED-CT Code 53958007
http://hl7.org/fhir/ValueSet/consent-action
from the FHIR Standard
Consent.provision.provision.typerequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1
from the FHIR Standard
Consent.provision.provision.actionexamplePattern: SNOMED-CT Code 53958007
http://hl7.org/fhir/ValueSet/consent-action
from the FHIR Standard
Consent.provision.provision.data.meaningrequiredFixed Value: instance
http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-cons-aodr-01errorConsent.patientAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-cons-aodr-02errorConsent.provisionSpecific provisions shall be specified if the individual is willing to donate, otherwise prohibited
: provision.exists() xor (type='deny')
inv-dh-cons-aodr-03errorConsent.dateTimeDate shall be at least to day
: toString().length() >= 10
inv-dh-cons-aodr-04errorConsent.performerAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-cons-aodr-05errorConsent.organizationAt least reference or display or a valid identifier shall be present
: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists()

Snapshot View

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Consent.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1
from the FHIR Standard
Consent.scopeextensiblePattern: adr
http://hl7.org/fhir/ValueSet/consent-scope
from the FHIR Standard
Consent.categoryextensibleConsentCategoryCodes
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:healthextensiblePattern: LOINC Code 59284-0
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.category:aodrextensiblePattern: LOINC Code 64300-7
http://hl7.org/fhir/ValueSet/consent-category
from the FHIR Standard
Consent.policyRuleextensibleConsentPolicyRuleCodes
http://hl7.org/fhir/ValueSet/consent-policy
from the FHIR Standard
Consent.provision.typerequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1
from the FHIR Standard
Consent.provision.actor.roleextensibleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Consent.provision.actionexamplePattern: SNOMED-CT Code 53958007
http://hl7.org/fhir/ValueSet/consent-action
from the FHIR Standard
Consent.provision.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Consent.provision.purposeextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.classextensibleConsentContentClass
http://hl7.org/fhir/ValueSet/consent-content-class
from the FHIR Standard
Consent.provision.codeexampleConsentContentCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/consent-content-code
from the FHIR Standard
Consent.provision.data.meaningrequiredConsentDataMeaning
http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1
from the FHIR Standard
Consent.provision.provision.typerequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1
from the FHIR Standard
Consent.provision.provision.actor.roleextensibleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Consent.provision.provision.actionexamplePattern: SNOMED-CT Code 53958007
http://hl7.org/fhir/ValueSet/consent-action
from the FHIR Standard
Consent.provision.provision.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Consent.provision.provision.purposeextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.provision.classextensibleConsentContentClass
http://hl7.org/fhir/ValueSet/consent-content-class
from the FHIR Standard
Consent.provision.provision.codeexampleConsentContentCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/consent-content-code
from the FHIR Standard
Consent.provision.provision.data.meaningrequiredFixed Value: instance
http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1
from the FHIR Standard
Consent.provision.provision.data.reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-cons-aodr-01errorConsent.patientAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-cons-aodr-02errorConsent.provisionSpecific provisions shall be specified if the individual is willing to donate, otherwise prohibited
: provision.exists() xor (type='deny')
inv-dh-cons-aodr-03errorConsent.dateTimeDate shall be at least to day
: toString().length() >= 10
inv-dh-cons-aodr-04errorConsent.performerAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-cons-aodr-05errorConsent.organizationAt least reference or display or a valid identifier shall be present
: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists()

This structure is derived from Consent

Summary

Mandatory: 13 elements(4 nested mandatory elements)
Must-Support: 20 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Name Type Conformance Description Path
identifier token SHALL Identifier for this record (external references) Consent.identifier
patient:identifier token SHALL Who the consent applies to Consent.patient.identifier
category token SHALL Classification of the consent statement - for indexing/retrieval Consent.category
date date SHOULD When this Consent was created or indexed Consent.dateTime
status token SHALL draft | proposed | active | rejected | inactive | entered-in-error Consent.status

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching for all consent statements for a patient using the patient:identifier search parameter:

    GET [base]/Consent?patient:identifier={system|}[code]

    Example:

     GET [base]/Consent?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437
    

    Implementation Notes: Fetches a bundle of all Consent resources for the specified patient (how to search by :identifier)

  2. SHALL support searching using the identifier search parameter:

    GET [base]/Consent?identifier={system|}[code]

    Example:

     GET [base]/Consent?identifier=urn:ietf:rfc:3986|urn:uuid:44a8f148-f5f7-447c-9e68-a9f06635ab6c
    

    Implementation Notes: Fetches a bundle containing any Consent resources matching the identifier (how to search by token)

  3. SHALL support searching using the combination patient:identifier and category and status search parameter:
    • including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/Consent?patient:identifier={system|}[code]&category={system|}[code]&status={system|}[code]

    Example:

     GET [base]/Consent?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&category=http://loinc.org|64300-7&status=active
    

    Implementation Notes: Fetches a bundle of all active Consent resources with the category of "Organ donation consent" for the specified patient (how to search by :identifier and how to search by token)

  4. SHOULD support searching using the combination of the patient:identifier and date and status search parameters:
    • including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/Consent?patient:identifier={system|}[code]&date=[date]&status={system|}[code]

    Example:

     GET [base]/Consent?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&date=ge2013-03-14&status=active
    

    Implementation Notes: Fetches a bundle of all active Consent resources for the specified patient that have a date greater than or equal to 21st Jan 2013. (how to search by :identifier and how to search by date)