Da Vinci Payer Data Exchange, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-epdx/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
Definitions for the provider-treatment-relationship-consent resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Consent | |
| Definition | A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. |
| Short | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time |
| Comments | Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives. |
| Control | 0..* |
| Is Modifier | false |
| Summary | false |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) 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 (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) ppc-1: Either a Policy or PolicyRule ( policy.exists() or policyRule.exists())ppc-2: IF Scope=privacy, there must be a patient ( patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not())ppc-3: IF Scope=research, there must be a patient ( patient.exists() or scope.coding.where(system='something' and code='research').exists().not())ppc-4: IF Scope=adr, there must be a patient ( patient.exists() or scope.coding.where(system='something' and code='adr').exists().not())ppc-5: IF Scope=treatment, there must be a patient ( patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not())ppc-1: Either a Policy or PolicyRule (policy.exists() or policyRule.exists()) ppc-2: IF Scope=privacy, there must be a patient (patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()) ppc-3: IF Scope=research, there must be a patient (patient.exists() or scope.coding.where(system='something' and code='research').exists().not()) ppc-4: IF Scope=adr, there must be a patient (patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()) ppc-5: IF Scope=treatment, there must be a patient (patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()) |
| 2. Consent.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. Consent.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Summary | false |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 6. Consent.status | |
| Definition | Indicates whether this treatment relationship attestation is active, inactive, or has been entered in error Indicates the current state of this consent. |
| Short | Status of the treatment relationship attestationdraft | proposed | active | rejected | inactive | entered-in-error |
| Comments | This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Treatment Attestation Statushttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 (required to http://hl7.org/fhir/us/davinci-pdex/ValueSet/attestation-status-valueset) |
| Type | code |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Consent.scope | |
| Definition | Fixed to 'treatment' to indicate this consent represents a treatment relationship A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible. |
| Short | Treatment relationship scopeWhich of the four areas this resource covers (extensible) |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ConsentScopeCodeshttp://hl7.org/fhir/ValueSet/consent-scope|4.0.1 (extensible to http://hl7.org/fhir/ValueSet/consent-scope|4.0.1)The four anticipated uses for the Consent Resource. |
| Type | CodeableConcept |
| Is Modifier | true because Allows changes to codes based on scope selection |
| Must Support | true |
| Summary | true |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Consent.category | |
| Definition | Classification of the type of consent. Should include codes indicating treatment relationship and attestation A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. |
| Short | Classification of consent (e.g., treatment relationship, attestation)Classification of the consent statement - for indexing/retrieval |
| Control | 1..* |
| Binding | Unless not suitable, these codes SHALL be taken from ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category|4.0.1 (extensible to http://hl7.org/fhir/ValueSet/consent-category) |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Consent.patient | |
| Definition | Reference to the patient for whom the treatment relationship is being attested The patient/healthcare consumer to whom this consent applies. |
| Short | Patient who is the subject of the treatment relationshipWho the consent applies to |
| Comments | Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person. |
| Control | 10..1 |
| Type | Reference(Patient) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. Consent.dateTime | |
| Definition | When this treatment relationship attestation was recorded or last updated When this Consent was issued / created / indexed. |
| Short | Date/time when treatment relationship attestation was recordedWhen this Consent was created or indexed |
| Comments | This is not the time of the original consent, but the time that this statement was made or derived. |
| Control | 10..1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Consent.performer | |
| Definition | The healthcare provider (practitioner, organization, or facility) attesting that they have a treatment relationship with the patient Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions. |
| Short | Practitioner, facility, or organization attesting to treatment relationshipWho is agreeing to the policy and rules |
| Comments | Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian. |
| Control | 10..* |
| Type | Reference(Practitioner, Organization, PractitionerRole, Organization, Patient, Practitioner, RelatedPerson, PractitionerRole) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| Alternate Names | consentor |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. Consent.organization | |
| Definition | The healthcare organization under which this treatment relationship exists The organization that manages the consent, and the framework within which it is executed. |
| Short | Organization responsible for the treatment relationshipCustodian of the consent |
| Control | 0..1* |
| Type | Reference(Organization) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Alternate Names | custodian |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. Consent.source[x] | |
| Definition | Reference to the source document, system, or person who provided the attestation The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document. |
| Short | Source of the attestationSource from which this consent is taken |
| Comments | The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id. |
| Control | 0..1 |
| Type | Choice of: Attachment, Reference(Consent, DocumentReference, Contract, QuestionnaireResponse) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. Consent.policy | |
| Definition | References to applicable policies, regulations, or legal frameworks governing treatment relationships The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. |
| Short | Policies or regulations governing the treatment relationshipPolicies covered by this consent |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. Consent.policy.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 26. Consent.verification | |
| Definition | Information about verification of the treatment relationship attestation Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person. |
| Short | Verification of the treatment relationship attestationConsent Verified by patient or family |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. Consent.verification.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 30. Consent.verification.verified | |
| Definition | Has the instruction been verified. |
| Short | Whether the attestation has been verifiedHas been verified |
| Control | 1..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. Consent.verification.verifiedWith | |
| Definition | Who verified the instruction (Patient, Relative or other Authorized Person). |
| Short | Who verified the attestationPerson who verified |
| Control | 0..1 |
| Type | Reference(Patient, RelatedPerson) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. Consent.verification.verificationDate | |
| Definition | Date verification was collected. |
| Short | When the attestation was verifiedWhen consent verified |
| Control | 0..1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. Consent.provision | |
| Definition | Detailed provisions about the scope, purpose, and period of the treatment relationship An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. |
| Short | Details of the treatment relationshipConstraints to the base Consent.policyRule |
| Control | 0..1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 38. Consent.provision.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 40. Consent.provision.type | |
| Definition | For treatment relationships, this should typically be 'permit' indicating an active relationship Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules. |
| Short | Whether this is a permission (permit) or denialdeny | permit |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Treatment Attestation Provision Typehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 (required to http://hl7.org/fhir/us/davinci-pdex/ValueSet/attestation-provision-type-valueset) |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. Consent.provision.period | |
| Definition | The time period during which the treatment relationship is valid or was active The timeframe in this rule is valid. |
| Short | Time period for the treatment relationshipTimeframe for this rule |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. Consent.provision.period.start | |
| Definition | The start of the period. The boundary is inclusive. |
| Short | Start date of treatment relationshipStarting time with inclusive boundary |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| Control | 0..1 This element is affected by the following invariants: per-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. Consent.provision.actor | |
| Definition | Specific practitioners, organizations, or facilities involved in providing care under this treatment relationship Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). |
| Short | Actors involved in the treatment relationshipWho|what controlled by this rule (or group, by role) |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Meaning if Missing | There is no specific actor associated with the exception |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. Consent.provision.actor.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 50. Consent.provision.actor.role | |
| Definition | How the individual is involved in the resources content that is described in the exception. |
| Short | How the actor is involved |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type|4.0.1 (extensible to http://hl7.org/fhir/ValueSet/security-role-type|4.0.1)How an actor is involved in the consent considerations. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 52. Consent.provision.actor.reference | |
| Definition | The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). |
| Short | Resource for the actor (or group, by role) |
| Control | 1..1 |
| Type | Reference(Practitioner, Organization, PractitionerRole, CareTeam, Device, Group, CareTeam, Organization, Patient, Practitioner, RelatedPerson, PractitionerRole) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. Consent.provision.purpose | |
| Definition | The purpose(s) for which the treatment relationship allows access to patient information (e.g., treatment, care coordination, quality improvement) The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule. |
| Short | Purpose of accessing patient informationContext of activities covered by this rule |
| Comments | When the purpose of use tag is on the data, access request purpose of use shall not conflict. |
| Control | 0..* |
| Binding | Unless not suitable, these codes SHALL be taken from PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse (extensible to http://terminology.hl7.org/ValueSet/v3-PurposeOfUse) |
| Type | Coding |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Consent | |
| 2. Consent.status | |
| Definition | Indicates whether this treatment relationship attestation is active, inactive, or has been entered in error |
| Short | Status of the treatment relationship attestation |
| Binding | The codes SHALL be taken from Treatment Attestation Status (required to http://hl7.org/fhir/us/davinci-pdex/ValueSet/attestation-status-valueset) |
| Must Support | true |
| 4. Consent.scope | |
| Definition | Fixed to 'treatment' to indicate this consent represents a treatment relationship |
| Short | Treatment relationship scope |
| Must Support | true |
| Pattern Value | { |
| 6. Consent.category | |
| Definition | Classification of the type of consent. Should include codes indicating treatment relationship and attestation |
| Short | Classification of consent (e.g., treatment relationship, attestation) |
| Binding | Unless not suitable, these codes SHALL be taken from ConsentCategoryCodes (extensible to http://hl7.org/fhir/ValueSet/consent-category) |
| Must Support | true |
| 8. Consent.patient | |
| Definition | Reference to the patient for whom the treatment relationship is being attested |
| Short | Patient who is the subject of the treatment relationship |
| Control | 1..? |
| Must Support | true |
| 10. Consent.dateTime | |
| Definition | When this treatment relationship attestation was recorded or last updated |
| Short | Date/time when treatment relationship attestation was recorded |
| Control | 1..? |
| Must Support | true |
| 12. Consent.performer | |
| Definition | The healthcare provider (practitioner, organization, or facility) attesting that they have a treatment relationship with the patient |
| Short | Practitioner, facility, or organization attesting to treatment relationship |
| Control | 1..? |
| Type | Reference(Practitioner, Organization, PractitionerRole) |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| 14. Consent.organization | |
| Definition | The healthcare organization under which this treatment relationship exists |
| Short | Organization responsible for the treatment relationship |
| Control | 0..1 |
| Must Support | true |
| 16. Consent.source[x] | |
| Definition | Reference to the source document, system, or person who provided the attestation |
| Short | Source of the attestation |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Must Support | true |
| 18. Consent.policy | |
| Definition | References to applicable policies, regulations, or legal frameworks governing treatment relationships |
| Short | Policies or regulations governing the treatment relationship |
| Must Support | true |
| 20. Consent.verification | |
| Definition | Information about verification of the treatment relationship attestation |
| Short | Verification of the treatment relationship attestation |
| Must Support | true |
| 22. Consent.verification.verified | |
| Short | Whether the attestation has been verified |
| Must Support | true |
| 24. Consent.verification.verifiedWith | |
| Short | Who verified the attestation |
| Must Support | true |
| 26. Consent.verification.verificationDate | |
| Short | When the attestation was verified |
| Must Support | true |
| 28. Consent.provision | |
| Definition | Detailed provisions about the scope, purpose, and period of the treatment relationship |
| Short | Details of the treatment relationship |
| Must Support | true |
| 30. Consent.provision.type | |
| Definition | For treatment relationships, this should typically be 'permit' indicating an active relationship |
| Short | Whether this is a permission (permit) or denial |
| Binding | The codes SHALL be taken from Treatment Attestation Provision Type (required to http://hl7.org/fhir/us/davinci-pdex/ValueSet/attestation-provision-type-valueset) |
| Must Support | true |
| 32. Consent.provision.period | |
| Definition | The time period during which the treatment relationship is valid or was active |
| Short | Time period for the treatment relationship |
| Must Support | true |
| 34. Consent.provision.period.start | |
| Short | Start date of treatment relationship |
| Must Support | true |
| 36. Consent.provision.actor | |
| Definition | Specific practitioners, organizations, or facilities involved in providing care under this treatment relationship |
| Short | Actors involved in the treatment relationship |
| Must Support | true |
| 38. Consent.provision.actor.role | |
| Must Support | true |
| 40. Consent.provision.actor.reference | |
| Type | Reference(Practitioner, Organization, PractitionerRole, CareTeam) |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| 42. Consent.provision.purpose | |
| Definition | The purpose(s) for which the treatment relationship allows access to patient information (e.g., treatment, care coordination, quality improvement) |
| Short | Purpose of accessing patient information |
| Binding | Unless not suitable, these codes SHALL be taken from PurposeOfUse (extensible to http://terminology.hl7.org/ValueSet/v3-PurposeOfUse) |
| Must Support | true |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Consent | |||||
| Definition | A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. | ||||
| Short | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | ||||
| Comments | Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives. | ||||
| Control | 0..* | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())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 ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())ppc-1: Either a Policy or PolicyRule ( policy.exists() or policyRule.exists())ppc-2: IF Scope=privacy, there must be a patient ( patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not())ppc-3: IF Scope=research, there must be a patient ( patient.exists() or scope.coding.where(system='something' and code='research').exists().not())ppc-4: IF Scope=adr, there must be a patient ( patient.exists() or scope.coding.where(system='something' and code='adr').exists().not())ppc-5: IF Scope=treatment, there must be a patient ( patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()) | ||||
| 2. Consent.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 4. Consent.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. Consent.implicitRules | |||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 8. Consent.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 10. Consent.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. Consent.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| Short | Contained, inline Resources | ||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. Consent.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 16. Consent.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Summary | false | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. Consent.identifier | |||||
| Definition | Unique identifier for this copy of the Consent Statement. | ||||
| Short | Identifier for this record (external references) | ||||
| Comments | This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Example | General: { "system" : "http://acme.org/identifier/local/eCMS", "value" : "Local eCMS identifier" } | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 20. Consent.status | |||||
| Definition | Indicates whether this treatment relationship attestation is active, inactive, or has been entered in error | ||||
| Short | Status of the treatment relationship attestation | ||||
| Comments | This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from Treatment Attestation Status (required to http://hl7.org/fhir/us/davinci-pdex/ValueSet/attestation-status-valueset) | ||||
| Type | code | ||||
| Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 22. Consent.scope | |||||
| Definition | Fixed to 'treatment' to indicate this consent represents a treatment relationship | ||||
| Short | Treatment relationship scope | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ConsentScopeCodes (extensible to http://hl7.org/fhir/ValueSet/consent-scope|4.0.1)The four anticipated uses for the Consent Resource. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | true because Allows changes to codes based on scope selection | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 24. Consent.category | |||||
| Definition | Classification of the type of consent. Should include codes indicating treatment relationship and attestation | ||||
| Short | Classification of consent (e.g., treatment relationship, attestation) | ||||
| Control | 1..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ConsentCategoryCodes (extensible to http://hl7.org/fhir/ValueSet/consent-category) | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. Consent.patient | |||||
| Definition | Reference to the patient for whom the treatment relationship is being attested | ||||
| Short | Patient who is the subject of the treatment relationship | ||||
| Comments | Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person. | ||||
| Control | 1..1 | ||||
| Type | Reference(Patient) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 28. Consent.dateTime | |||||
| Definition | When this treatment relationship attestation was recorded or last updated | ||||
| Short | Date/time when treatment relationship attestation was recorded | ||||
| Comments | This is not the time of the original consent, but the time that this statement was made or derived. | ||||
| Control | 1..1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 30. Consent.performer | |||||
| Definition | The healthcare provider (practitioner, organization, or facility) attesting that they have a treatment relationship with the patient | ||||
| Short | Practitioner, facility, or organization attesting to treatment relationship | ||||
| Comments | Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian. | ||||
| Control | 1..* | ||||
| Type | Reference(Practitioner, Organization, PractitionerRole) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| Alternate Names | consentor | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 32. Consent.organization | |||||
| Definition | The healthcare organization under which this treatment relationship exists | ||||
| Short | Organization responsible for the treatment relationship | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Alternate Names | custodian | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 34. Consent.source[x] | |||||
| Definition | Reference to the source document, system, or person who provided the attestation | ||||
| Short | Source of the attestation | ||||
| Comments | The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id. | ||||
| Control | 0..1 | ||||
| Type | Choice of: Attachment, Reference(Consent, DocumentReference, Contract, QuestionnaireResponse) | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 36. Consent.policy | |||||
| Definition | References to applicable policies, regulations, or legal frameworks governing treatment relationships | ||||
| Short | Policies or regulations governing the treatment relationship | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 38. Consent.policy.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 40. Consent.policy.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 42. Consent.policy.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 44. Consent.policy.authority | |||||
| Definition | Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives. | ||||
| Short | Enforcement source for policy | ||||
| Control | 0..1 This element is affected by the following invariants: ppc-1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 46. Consent.policy.uri | |||||
| Definition | The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. | ||||
| Short | Specific policy covered by this consent | ||||
| Comments | This element is for discoverability / documentation and does not modify or qualify the policy rules. | ||||
| Control | 0..1 This element is affected by the following invariants: ppc-1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 48. Consent.policyRule | |||||
| Definition | A reference to the specific base computable regulation or policy. | ||||
| Short | Regulation that this consents to | ||||
| Comments | If the policyRule is absent, computable consent would need to be constructed from the elements of the Consent resource. | ||||
| Control | 0..1 This element is affected by the following invariants: ppc-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ConsentPolicyRuleCodes (extensible to http://hl7.org/fhir/ValueSet/consent-policy|4.0.1)Regulatory policy examples. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Might be a unique identifier of a policy set in XACML, or other rules engine. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 50. Consent.verification | |||||
| Definition | Information about verification of the treatment relationship attestation | ||||
| Short | Verification of the treatment relationship attestation | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 52. Consent.verification.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 54. Consent.verification.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 56. Consent.verification.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 58. Consent.verification.verified | |||||
| Definition | Has the instruction been verified. | ||||
| Short | Whether the attestation has been verified | ||||
| Control | 1..1 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 60. Consent.verification.verifiedWith | |||||
| Definition | Who verified the instruction (Patient, Relative or other Authorized Person). | ||||
| Short | Who verified the attestation | ||||
| Control | 0..1 | ||||
| Type | Reference(Patient, RelatedPerson) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 62. Consent.verification.verificationDate | |||||
| Definition | Date verification was collected. | ||||
| Short | When the attestation was verified | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 64. Consent.provision | |||||
| Definition | Detailed provisions about the scope, purpose, and period of the treatment relationship | ||||
| Short | Details of the treatment relationship | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 66. Consent.provision.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 68. Consent.provision.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 70. Consent.provision.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 72. Consent.provision.type | |||||
| Definition | For treatment relationships, this should typically be 'permit' indicating an active relationship | ||||
| Short | Whether this is a permission (permit) or denial | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from Treatment Attestation Provision Type (required to http://hl7.org/fhir/us/davinci-pdex/ValueSet/attestation-provision-type-valueset) | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 74. Consent.provision.period | |||||
| Definition | The time period during which the treatment relationship is valid or was active | ||||
| Short | Time period for the treatment relationship | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 76. Consent.provision.period.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 78. Consent.provision.period.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Consent.provision.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 80. Consent.provision.period.start | |||||
| Definition | The start of the period. The boundary is inclusive. | ||||
| Short | Start date of treatment relationship | ||||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 82. Consent.provision.period.end | |||||
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||||
| Short | End time with inclusive boundary, if not ongoing | ||||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 84. Consent.provision.actor | |||||
| Definition | Specific practitioners, organizations, or facilities involved in providing care under this treatment relationship | ||||
| Short | Actors involved in the treatment relationship | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Meaning if Missing | There is no specific actor associated with the exception | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 86. Consent.provision.actor.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 88. Consent.provision.actor.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 90. Consent.provision.actor.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 92. Consent.provision.actor.role | |||||
| Definition | How the individual is involved in the resources content that is described in the exception. | ||||
| Short | How the actor is involved | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from SecurityRoleType (extensible to http://hl7.org/fhir/ValueSet/security-role-type|4.0.1)How an actor is involved in the consent considerations. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 94. Consent.provision.actor.reference | |||||
| Definition | The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). | ||||
| Short | Resource for the actor (or group, by role) | ||||
| Control | 1..1 | ||||
| Type | Reference(Practitioner, Organization, PractitionerRole, CareTeam) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 96. Consent.provision.action | |||||
| Definition | Actions controlled by this Rule. | ||||
| Short | Actions controlled by this rule | ||||
| Comments | Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see ConsentActionCodes (example to http://hl7.org/fhir/ValueSet/consent-action|4.0.1)Detailed codes for the consent action. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Meaning if Missing | all actions | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 98. Consent.provision.securityLabel | |||||
| Definition | A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception. | ||||
| Short | Security Labels that define affected resources | ||||
| Comments | If the consent specifies a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 100. Consent.provision.purpose | |||||
| Definition | The purpose(s) for which the treatment relationship allows access to patient information (e.g., treatment, care coordination, quality improvement) | ||||
| Short | Purpose of accessing patient information | ||||
| Comments | When the purpose of use tag is on the data, access request purpose of use shall not conflict. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from PurposeOfUse (extensible to http://terminology.hl7.org/ValueSet/v3-PurposeOfUse) | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 102. Consent.provision.class | |||||
| Definition | The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. | ||||
| Short | e.g. Resource Type, Profile, CDA, etc. | ||||
| Comments | Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ConsentContentClass (extensible to http://hl7.org/fhir/ValueSet/consent-content-class|4.0.1)The class (type) of information a consent rule covers. | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 104. Consent.provision.code | |||||
| Definition | If this code is found in an instance, then the rule applies. | ||||
| Short | e.g. LOINC or SNOMED CT code, etc. in the content | ||||
| Comments | Typical use of this is a Document code with class = CDA. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see ConsentContentCodes (example to http://hl7.org/fhir/ValueSet/consent-content-code|4.0.1)If this code is found in an instance, then the exception applies. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 106. Consent.provision.dataPeriod | |||||
| Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this rule. | ||||
| Short | Timeframe for data controlled by this rule | ||||
| Comments | This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement. | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 108. Consent.provision.data | |||||
| Definition | The resources controlled by this rule if specific resources are referenced. | ||||
| Short | Data controlled by this rule | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Meaning if Missing | all data | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 110. Consent.provision.data.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 112. Consent.provision.data.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 114. Consent.provision.data.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 116. Consent.provision.data.meaning | |||||
| Definition | How the resource reference is interpreted when testing consent restrictions. | ||||
| Short | instance | related | dependents | authoredby | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from ConsentDataMeaning (required to http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1)How a resource reference is interpreted when testing consent restrictions. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 118. Consent.provision.data.reference | |||||
| Definition | A reference to a specific resource that defines which resources are covered by this consent. | ||||
| Short | The actual data reference | ||||
| Control | 1..1 | ||||
| Type | Reference(Resource) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 120. Consent.provision.provision | |||||
| Definition | Rules which provide exceptions to the base rule or subrules. | ||||
| Short | Nested Exception Rules | ||||
| Control | 0..* | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Consent#Consent.provision | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||