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
Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-consent-aodr-1 | Version: 1.0.1 | |||
Active as of 2024-12-19 | 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:
This profile may be referred to by APIs, which will be listed here when available.
Consent.provision.type
= "deny", see example Australian Organ Donor Register Consent - Not willing to be a donor.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:
Consent.provision.provision
with Consent.provision.provision.type
= "permit", see example Australian Organ Donor Register Consent - Willing to be a donor, donate all.Consent.provision.provision
with Consent.provision.provision.type
= "permit".Consent.provision.provision
with Consent.provision.provision.type
= "deny".Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | 0..* | Consent | Record of organ and tissue donation decision held by the Australian Organ Donor Register | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
dateInitialRegistration | S | 0..1 | dateTime | Date the individual first registered URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-date-initial-registration-1 |
identifier | S | 1..* | Identifier | Identifier for this record (external references) |
status | S | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Fixed Value: active |
scope | S | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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: adr | |
Slices for category | S | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this |
category:health | 1..1 | CodeableConcept | Consent for healthcare service, procedure, or activity Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59284-0 | |
category:aodr | 1..1 | CodeableConcept | Organ donation consent Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 64300-7 | |
patient | SC | 1..1 | Reference(ADHA Core Patient) | Who the consent applies to inv-dh-cons-aodr-01: At least reference or a valid identifier shall be present |
dateTime | SC | 1..1 | dateTime | When this Consent was created or indexed inv-dh-cons-aodr-03: Date shall be at least to day |
performer | SC | 1..1 | Reference(ADHA Core Patient) | Grantor of consent inv-dh-cons-aodr-04: At least reference or a valid identifier shall be present |
organization | SC | 1..1 | Reference(ADHA Core Organization) | Custodian of the consent inv-dh-cons-aodr-05: At least reference or display or a valid identifier shall be present |
policy | S | 1..1 | BackboneElement | Australian Organ Donor Register |
authority | S | 0..1 | uri | Enforcement source for policy Fixed Value: http://australianorgandonorregister.gov.au |
uri | S | 1..1 | uri | Specific policy covered by this consent Fixed Value: http://www.australianorgandonorregister.gov.au/aodr |
provision | SC | 1..1 | BackboneElement | Individual's decision about donation inv-dh-cons-aodr-02: Specific provisions shall be specified if the individual is willing to donate, otherwise prohibited |
type | S | 1..1 | code | deny | permit |
action | S | 1..1 | CodeableConcept | Removal of organ or tissue for donation Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 53958007 | |
provision | S | 0..* | BackboneElement | Individual's decision about donation of specific organ or tissue |
type | S | 1..1 | code | deny | permit |
action | S | 1..1 | CodeableConcept | Removal of organ or tissue for donation Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 53958007 | |
data | S | 1..1 | BackboneElement | The organ or tissue that is the target of the donation decision |
meaning | 1..1 | code | instance | related | dependents | authoredby Fixed Value: instance | |
reference | S | 1..1 | Reference(ADHA Organ or Tissue for Donation BodyStructure) | The actual data reference |
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-cons-aodr-01 | error | Consent.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cons-aodr-02 | error | Consent.provision | Specific provisions shall be specified if the individual is willing to donate, otherwise prohibited : provision.exists() xor (type='deny') | |
inv-dh-cons-aodr-03 | error | Consent.dateTime | Date shall be at least to day : toString().length() >= 10 | |
inv-dh-cons-aodr-04 | error | Consent.performer | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cons-aodr-05 | error | Consent.organization | At 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() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | C | 0..* | Consent | Record of organ and tissue donation decision held by the Australian Organ Donor Register 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 |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
dateInitialRegistration | S | 0..1 | dateTime | Date the individual first registered URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-date-initial-registration-1 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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 |
identifier | SΣ | 1..* | Identifier | Identifier for this record (external references) ele-1: All FHIR elements must have a @value or children Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} |
status | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. ele-1: All FHIR elements must have a @value or children Fixed Value: active |
scope | ?!SΣ | 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 Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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: adr | |
Slices for category | SΣ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this 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 |
category:health | Σ | 1..1 | CodeableConcept | Consent for healthcare service, procedure, or activity 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 Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59284-0 | |
category:aodr | Σ | 1..1 | CodeableConcept | Organ donation consent 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 Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 64300-7 | |
patient | SΣC | 1..1 | Reference(ADHA Core Patient) | Who the consent applies to ele-1: All FHIR elements must have a @value or children inv-dh-cons-aodr-01: At least reference or a valid identifier shall be present |
dateTime | SΣC | 1..1 | dateTime | When this Consent was created or indexed ele-1: All FHIR elements must have a @value or children inv-dh-cons-aodr-03: Date shall be at least to day |
performer | SΣC | 1..1 | Reference(ADHA Core Patient) | Grantor of consent ele-1: All FHIR elements must have a @value or children inv-dh-cons-aodr-04: At least reference or a valid identifier shall be present |
organization | SΣC | 1..1 | Reference(ADHA Core Organization) | Custodian of the consent ele-1: All FHIR elements must have a @value or children inv-dh-cons-aodr-05: At least reference or display or a valid identifier shall be present |
policy | S | 1..1 | BackboneElement | Australian Organ Donor Register 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 |
authority | SC | 0..1 | uri | Enforcement source for policy ele-1: All FHIR elements must have a @value or children Fixed Value: http://australianorgandonorregister.gov.au |
uri | SC | 1..1 | uri | Specific policy covered by this consent ele-1: All FHIR elements must have a @value or children Fixed Value: http://www.australianorgandonorregister.gov.au/aodr |
provision | SΣC | 1..1 | BackboneElement | Individual's decision about donation ele-1: All FHIR elements must have a @value or children inv-dh-cons-aodr-02: Specific provisions shall be specified if the individual is willing to donate, otherwise prohibited |
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 | SΣ | 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 |
action | SΣ | 1..1 | CodeableConcept | Removal of organ or tissue for donation Binding: ConsentActionCodes (example): Detailed codes for the consent action. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 53958007 | |
provision | S | 0..* | BackboneElement | Individual's decision about donation of specific organ or tissue 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 | SΣ | 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 |
action | SΣ | 1..1 | CodeableConcept | Removal of organ or tissue for donation Binding: ConsentActionCodes (example): Detailed codes for the consent action. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 53958007 | |
data | SΣ | 1..1 | BackboneElement | The organ or tissue that is the target of the donation decision 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 | Σ | 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: instance |
reference | SΣ | 1..1 | Reference(ADHA Organ or Tissue for Donation BodyStructure) | The actual data reference ele-1: All FHIR elements must have a @value or children |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL 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.1 from the FHIR Standard | |
Consent.scope | extensible | Pattern: adrhttp://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard | |
Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.category:health | extensible | Pattern: LOINC Code 59284-0http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.category:aodr | extensible | Pattern: LOINC Code 64300-7http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard | |
Consent.provision.action | example | Pattern: SNOMED-CT Code 53958007http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | |
Consent.provision.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard | |
Consent.provision.provision.action | example | Pattern: SNOMED-CT Code 53958007http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | |
Consent.provision.provision.data.meaning | required | Fixed Value: instancehttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-cons-aodr-01 | error | Consent.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cons-aodr-02 | error | Consent.provision | Specific provisions shall be specified if the individual is willing to donate, otherwise prohibited : provision.exists() xor (type='deny') | |
inv-dh-cons-aodr-03 | error | Consent.dateTime | Date shall be at least to day : toString().length() >= 10 | |
inv-dh-cons-aodr-04 | error | Consent.performer | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cons-aodr-05 | error | Consent.organization | At 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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Consent | C | 0..* | Consent | Record of organ and tissue donation decision held by the Australian Organ Donor Register ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
dateInitialRegistration | S | 0..1 | dateTime | Date the individual first registered URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-date-initial-registration-1 | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..* | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
status | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active | ||||
scope | ?!SΣ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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: adr | |||||
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 | |||||
Slices for category | SΣ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
category:health | Σ | 1..1 | CodeableConcept | Consent for healthcare service, procedure, or activity Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59284-0 | |||||
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:aodr | Σ | 1..1 | CodeableConcept | Organ donation consent Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 64300-7 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
patient | SΣC | 1..1 | Reference(ADHA Core Patient) | Who the consent applies to inv-dh-cons-aodr-01: At least reference or a valid identifier shall be present | ||||
dateTime | SΣC | 1..1 | dateTime | When this Consent was created or indexed inv-dh-cons-aodr-03: Date shall be at least to day | ||||
performer | SΣC | 1..1 | Reference(ADHA Core Patient) | Grantor of consent inv-dh-cons-aodr-04: At least reference or a valid identifier shall be present | ||||
organization | SΣC | 1..1 | Reference(ADHA Core Organization) | Custodian of the consent inv-dh-cons-aodr-05: At least reference or display or a valid identifier shall be present | ||||
source[x] | Σ | 0..1 | Source from which this consent is taken | |||||
sourceAttachment | Attachment | |||||||
sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
policy | S | 1..1 | BackboneElement | Australian Organ Donor Register | ||||
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 | SC | 0..1 | uri | Enforcement source for policy Fixed Value: http://australianorgandonorregister.gov.au | ||||
uri | SC | 1..1 | uri | Specific policy covered by this consent Fixed Value: http://www.australianorgandonorregister.gov.au/aodr | ||||
policyRule | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
verification | Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
verified | Σ | 1..1 | boolean | Has been verified | ||||
verifiedWith | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
verificationDate | 0..1 | dateTime | When consent verified | |||||
provision | SΣC | 1..1 | BackboneElement | Individual's decision about donation inv-dh-cons-aodr-02: Specific provisions shall be specified if the individual is willing to donate, otherwise prohibited | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | SΣ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
period | Σ | 0..1 | Period | Timeframe for this rule | ||||
actor | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
action | SΣ | 1..1 | CodeableConcept | Removal of organ or tissue for donation Binding: ConsentActionCodes (example): Detailed codes for the consent action. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 53958007 | |||||
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. | ||||
class | Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
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 | Σ | 0..* | 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 | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
provision | S | 0..* | BackboneElement | Individual's decision about donation of specific organ or tissue | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | SΣ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
period | Σ | 0..1 | Period | Timeframe for this rule | ||||
actor | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
action | SΣ | 1..1 | CodeableConcept | Removal of organ or tissue for donation Binding: ConsentActionCodes (example): Detailed codes for the consent action. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 53958007 | |||||
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. | ||||
class | Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
code | Σ | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. | ||||
dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
data | SΣ | 1..1 | BackboneElement | The organ or tissue that is the target of the donation decision | ||||
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 | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Fixed Value: instance | ||||
reference | SΣ | 1..1 | Reference(ADHA Organ or Tissue for Donation BodyStructure) | The actual data reference | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
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/languages from the FHIR Standard
| ||||
Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 from the FHIR Standard | ||||
Consent.scope | extensible | Pattern: adrhttp://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard | ||||
Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.category:health | extensible | Pattern: LOINC Code 59284-0http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.category:aodr | extensible | Pattern: LOINC Code 64300-7http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policy from the FHIR Standard | ||||
Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard | ||||
Consent.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.provision.action | example | Pattern: SNOMED-CT Code 53958007http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | ||||
Consent.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from 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-class from the FHIR Standard | ||||
Consent.provision.code | example | ConsentContentCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-code from the FHIR Standard | ||||
Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard | ||||
Consent.provision.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard | ||||
Consent.provision.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.provision.provision.action | example | Pattern: SNOMED-CT Code 53958007http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | ||||
Consent.provision.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Consent.provision.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
Consent.provision.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-class from the FHIR Standard | ||||
Consent.provision.provision.code | example | ConsentContentCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-code from the FHIR Standard | ||||
Consent.provision.provision.data.meaning | required | Fixed Value: instancehttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard | ||||
Consent.provision.provision.data.reference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-cons-aodr-01 | error | Consent.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cons-aodr-02 | error | Consent.provision | Specific provisions shall be specified if the individual is willing to donate, otherwise prohibited : provision.exists() xor (type='deny') | |
inv-dh-cons-aodr-03 | error | Consent.dateTime | Date shall be at least to day : toString().length() >= 10 | |
inv-dh-cons-aodr-04 | error | Consent.performer | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cons-aodr-05 | error | Consent.organization | At 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:
Differential View
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | 0..* | Consent | Record of organ and tissue donation decision held by the Australian Organ Donor Register | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
dateInitialRegistration | S | 0..1 | dateTime | Date the individual first registered URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-date-initial-registration-1 |
identifier | S | 1..* | Identifier | Identifier for this record (external references) |
status | S | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Fixed Value: active |
scope | S | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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: adr | |
Slices for category | S | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this |
category:health | 1..1 | CodeableConcept | Consent for healthcare service, procedure, or activity Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59284-0 | |
category:aodr | 1..1 | CodeableConcept | Organ donation consent Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 64300-7 | |
patient | SC | 1..1 | Reference(ADHA Core Patient) | Who the consent applies to inv-dh-cons-aodr-01: At least reference or a valid identifier shall be present |
dateTime | SC | 1..1 | dateTime | When this Consent was created or indexed inv-dh-cons-aodr-03: Date shall be at least to day |
performer | SC | 1..1 | Reference(ADHA Core Patient) | Grantor of consent inv-dh-cons-aodr-04: At least reference or a valid identifier shall be present |
organization | SC | 1..1 | Reference(ADHA Core Organization) | Custodian of the consent inv-dh-cons-aodr-05: At least reference or display or a valid identifier shall be present |
policy | S | 1..1 | BackboneElement | Australian Organ Donor Register |
authority | S | 0..1 | uri | Enforcement source for policy Fixed Value: http://australianorgandonorregister.gov.au |
uri | S | 1..1 | uri | Specific policy covered by this consent Fixed Value: http://www.australianorgandonorregister.gov.au/aodr |
provision | SC | 1..1 | BackboneElement | Individual's decision about donation inv-dh-cons-aodr-02: Specific provisions shall be specified if the individual is willing to donate, otherwise prohibited |
type | S | 1..1 | code | deny | permit |
action | S | 1..1 | CodeableConcept | Removal of organ or tissue for donation Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 53958007 | |
provision | S | 0..* | BackboneElement | Individual's decision about donation of specific organ or tissue |
type | S | 1..1 | code | deny | permit |
action | S | 1..1 | CodeableConcept | Removal of organ or tissue for donation Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 53958007 | |
data | S | 1..1 | BackboneElement | The organ or tissue that is the target of the donation decision |
meaning | 1..1 | code | instance | related | dependents | authoredby Fixed Value: instance | |
reference | S | 1..1 | Reference(ADHA Organ or Tissue for Donation BodyStructure) | The actual data reference |
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-cons-aodr-01 | error | Consent.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cons-aodr-02 | error | Consent.provision | Specific provisions shall be specified if the individual is willing to donate, otherwise prohibited : provision.exists() xor (type='deny') | |
inv-dh-cons-aodr-03 | error | Consent.dateTime | Date shall be at least to day : toString().length() >= 10 | |
inv-dh-cons-aodr-04 | error | Consent.performer | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cons-aodr-05 | error | Consent.organization | At 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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | C | 0..* | Consent | Record of organ and tissue donation decision held by the Australian Organ Donor Register 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 |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
dateInitialRegistration | S | 0..1 | dateTime | Date the individual first registered URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-date-initial-registration-1 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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 |
identifier | SΣ | 1..* | Identifier | Identifier for this record (external references) ele-1: All FHIR elements must have a @value or children Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} |
status | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. ele-1: All FHIR elements must have a @value or children Fixed Value: active |
scope | ?!SΣ | 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 Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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: adr | |
Slices for category | SΣ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this 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 |
category:health | Σ | 1..1 | CodeableConcept | Consent for healthcare service, procedure, or activity 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 Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59284-0 | |
category:aodr | Σ | 1..1 | CodeableConcept | Organ donation consent 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 Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 64300-7 | |
patient | SΣC | 1..1 | Reference(ADHA Core Patient) | Who the consent applies to ele-1: All FHIR elements must have a @value or children inv-dh-cons-aodr-01: At least reference or a valid identifier shall be present |
dateTime | SΣC | 1..1 | dateTime | When this Consent was created or indexed ele-1: All FHIR elements must have a @value or children inv-dh-cons-aodr-03: Date shall be at least to day |
performer | SΣC | 1..1 | Reference(ADHA Core Patient) | Grantor of consent ele-1: All FHIR elements must have a @value or children inv-dh-cons-aodr-04: At least reference or a valid identifier shall be present |
organization | SΣC | 1..1 | Reference(ADHA Core Organization) | Custodian of the consent ele-1: All FHIR elements must have a @value or children inv-dh-cons-aodr-05: At least reference or display or a valid identifier shall be present |
policy | S | 1..1 | BackboneElement | Australian Organ Donor Register 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 |
authority | SC | 0..1 | uri | Enforcement source for policy ele-1: All FHIR elements must have a @value or children Fixed Value: http://australianorgandonorregister.gov.au |
uri | SC | 1..1 | uri | Specific policy covered by this consent ele-1: All FHIR elements must have a @value or children Fixed Value: http://www.australianorgandonorregister.gov.au/aodr |
provision | SΣC | 1..1 | BackboneElement | Individual's decision about donation ele-1: All FHIR elements must have a @value or children inv-dh-cons-aodr-02: Specific provisions shall be specified if the individual is willing to donate, otherwise prohibited |
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 | SΣ | 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 |
action | SΣ | 1..1 | CodeableConcept | Removal of organ or tissue for donation Binding: ConsentActionCodes (example): Detailed codes for the consent action. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 53958007 | |
provision | S | 0..* | BackboneElement | Individual's decision about donation of specific organ or tissue 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 | SΣ | 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 |
action | SΣ | 1..1 | CodeableConcept | Removal of organ or tissue for donation Binding: ConsentActionCodes (example): Detailed codes for the consent action. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 53958007 | |
data | SΣ | 1..1 | BackboneElement | The organ or tissue that is the target of the donation decision 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 | Σ | 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: instance |
reference | SΣ | 1..1 | Reference(ADHA Organ or Tissue for Donation BodyStructure) | The actual data reference ele-1: All FHIR elements must have a @value or children |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL 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.1 from the FHIR Standard | |
Consent.scope | extensible | Pattern: adrhttp://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard | |
Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.category:health | extensible | Pattern: LOINC Code 59284-0http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.category:aodr | extensible | Pattern: LOINC Code 64300-7http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard | |
Consent.provision.action | example | Pattern: SNOMED-CT Code 53958007http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | |
Consent.provision.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard | |
Consent.provision.provision.action | example | Pattern: SNOMED-CT Code 53958007http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | |
Consent.provision.provision.data.meaning | required | Fixed Value: instancehttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-cons-aodr-01 | error | Consent.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cons-aodr-02 | error | Consent.provision | Specific provisions shall be specified if the individual is willing to donate, otherwise prohibited : provision.exists() xor (type='deny') | |
inv-dh-cons-aodr-03 | error | Consent.dateTime | Date shall be at least to day : toString().length() >= 10 | |
inv-dh-cons-aodr-04 | error | Consent.performer | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cons-aodr-05 | error | Consent.organization | At 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
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Consent | C | 0..* | Consent | Record of organ and tissue donation decision held by the Australian Organ Donor Register ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
dateInitialRegistration | S | 0..1 | dateTime | Date the individual first registered URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-date-initial-registration-1 | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..* | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
status | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Fixed Value: active | ||||
scope | ?!SΣ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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: adr | |||||
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 | |||||
Slices for category | SΣ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by pattern:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
category:health | Σ | 1..1 | CodeableConcept | Consent for healthcare service, procedure, or activity Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59284-0 | |||||
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:aodr | Σ | 1..1 | CodeableConcept | Organ donation consent Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 64300-7 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
patient | SΣC | 1..1 | Reference(ADHA Core Patient) | Who the consent applies to inv-dh-cons-aodr-01: At least reference or a valid identifier shall be present | ||||
dateTime | SΣC | 1..1 | dateTime | When this Consent was created or indexed inv-dh-cons-aodr-03: Date shall be at least to day | ||||
performer | SΣC | 1..1 | Reference(ADHA Core Patient) | Grantor of consent inv-dh-cons-aodr-04: At least reference or a valid identifier shall be present | ||||
organization | SΣC | 1..1 | Reference(ADHA Core Organization) | Custodian of the consent inv-dh-cons-aodr-05: At least reference or display or a valid identifier shall be present | ||||
source[x] | Σ | 0..1 | Source from which this consent is taken | |||||
sourceAttachment | Attachment | |||||||
sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
policy | S | 1..1 | BackboneElement | Australian Organ Donor Register | ||||
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 | SC | 0..1 | uri | Enforcement source for policy Fixed Value: http://australianorgandonorregister.gov.au | ||||
uri | SC | 1..1 | uri | Specific policy covered by this consent Fixed Value: http://www.australianorgandonorregister.gov.au/aodr | ||||
policyRule | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
verification | Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
verified | Σ | 1..1 | boolean | Has been verified | ||||
verifiedWith | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
verificationDate | 0..1 | dateTime | When consent verified | |||||
provision | SΣC | 1..1 | BackboneElement | Individual's decision about donation inv-dh-cons-aodr-02: Specific provisions shall be specified if the individual is willing to donate, otherwise prohibited | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | SΣ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
period | Σ | 0..1 | Period | Timeframe for this rule | ||||
actor | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
action | SΣ | 1..1 | CodeableConcept | Removal of organ or tissue for donation Binding: ConsentActionCodes (example): Detailed codes for the consent action. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 53958007 | |||||
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. | ||||
class | Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
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 | Σ | 0..* | 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 | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
provision | S | 0..* | BackboneElement | Individual's decision about donation of specific organ or tissue | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | SΣ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
period | Σ | 0..1 | Period | Timeframe for this rule | ||||
actor | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
action | SΣ | 1..1 | CodeableConcept | Removal of organ or tissue for donation Binding: ConsentActionCodes (example): Detailed codes for the consent action. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 53958007 | |||||
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. | ||||
class | Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
code | Σ | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. | ||||
dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
data | SΣ | 1..1 | BackboneElement | The organ or tissue that is the target of the donation decision | ||||
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 | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Fixed Value: instance | ||||
reference | SΣ | 1..1 | Reference(ADHA Organ or Tissue for Donation BodyStructure) | The actual data reference | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
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/languages from the FHIR Standard
| ||||
Consent.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 from the FHIR Standard | ||||
Consent.scope | extensible | Pattern: adrhttp://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard | ||||
Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.category:health | extensible | Pattern: LOINC Code 59284-0http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.category:aodr | extensible | Pattern: LOINC Code 64300-7http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policy from the FHIR Standard | ||||
Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard | ||||
Consent.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.provision.action | example | Pattern: SNOMED-CT Code 53958007http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | ||||
Consent.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from 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-class from the FHIR Standard | ||||
Consent.provision.code | example | ConsentContentCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-code from the FHIR Standard | ||||
Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard | ||||
Consent.provision.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard | ||||
Consent.provision.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
Consent.provision.provision.action | example | Pattern: SNOMED-CT Code 53958007http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard | ||||
Consent.provision.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Consent.provision.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
Consent.provision.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-class from the FHIR Standard | ||||
Consent.provision.provision.code | example | ConsentContentCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-code from the FHIR Standard | ||||
Consent.provision.provision.data.meaning | required | Fixed Value: instancehttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard | ||||
Consent.provision.provision.data.reference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-cons-aodr-01 | error | Consent.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cons-aodr-02 | error | Consent.provision | Specific provisions shall be specified if the individual is willing to donate, otherwise prohibited : provision.exists() xor (type='deny') | |
inv-dh-cons-aodr-03 | error | Consent.dateTime | Date shall be at least to day : toString().length() >= 10 | |
inv-dh-cons-aodr-04 | error | Consent.performer | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-cons-aodr-05 | error | Consent.organization | At 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:
Other representations of profile: CSV, Excel, Schematron
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 |
The following search parameters and search parameter combinations SHALL be supported:
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)
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)
patient:identifier
and category
and status
search parameter:
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)
patient:identifier
and date
and status
search parameters:
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)