POCP Prescription Enrollment
0.1.0 - CI Build US

POCP Prescription Enrollment - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: RxEnrollConsent - Detailed Descriptions

Active as of 2022-02-27

Definitions for the rx-enroll-consent resource profile.

1. 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.

Control0..*
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.

InvariantsDefined on this element
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.

Control0..1
Typestring
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.

3. 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.

Control0..1
TypeMeta
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. 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.

Control0..1
Typeuri
Is Modifiertrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Consent.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages A human language.

Typecode
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. 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.

Control0..1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. 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.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained 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.

8. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
9. 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, user content
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.

InvariantsDefined on this element
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())
10. Consent.identifier
Definition

Unique identifier for this copy of the Consent Statement.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
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.

Example
General:<valueIdentifier xmlns="http://hl7.org/fhir">
  <system value="urn:ietf:rfc:3986"/>
  <value value="Local eCMS identifier"/>
</valueIdentifier>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Consent.status
Definition

Indicates the current state of this consent.

Control1..1
BindingThe codes SHALL be taken from Rx Enroll Value Set - Consent Status
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Consent.scope
Definition

A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.

Control1..1
BindingThe codes SHALL be taken from ConsentScopeCodes; other codes may be used where these codes are not suitable The four anticipated uses for the Consent Resource.

TypeCodeableConcept
Is Modifiertrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Consent.category
Definition

A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

Control1..*
BindingThe codes SHALL be taken from ConsentCategoryCodes; other codes may be used where these codes are not suitable A classification of the type of consents found in a consent statement.

TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Consent.patient
Definition

The patient for whom the related prescription was written, as represented in the Data Source system

Control0..1
TypeReference(USCorePatientProfile)
Must Supporttrue
Comments

Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Consent.dateTime
Definition

When this Consent was issued / created / indexed.

Control1..1
TypedateTime
Must Supporttrue
Comments

This is not the time of the original consent, but the time that this statement was made or derived.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Consent.performer
Definition

Reference to a patient (Patient resource), authorized patient representative (Related Person resource) or provider (Practitioner resource)

Control1..*
TypeReference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Alternate Namesconsentor
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Consent.organization
Definition

The provider organization at which the patient prescription originated. Reference to an Organization resource representing the practice or health system

Control1..*
TypeReference(Organization)
Must Supporttrue
Alternate Namescustodian
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Consent.source[x]
Definition

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.

Control1..1
TypeAttachment
[x] NoteSee Choice of Data Types for further information about how to use [x]
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Consent.source[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
19. Consent.source[x]:sourceAttachment
SliceNamesourceAttachment
Definition

A file capturing the patient choices and authorizations

Control1..1
TypeAttachment
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Consent.source[x]:sourceAttachment.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
21. Consent.source[x]:sourceAttachment.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Consent.source[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
22. Consent.source[x]:sourceAttachment.contentType
Definition

Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

Control1..1
BindingThe codes SHALL be taken from Mime Types The mime type of an attachment. Any valid mime type is allowed.

Typecode
Must Supporttrue
Requirements

Processors of the data need to be able to know how to interpret the data.

Fixed Valueapplication/fhir+json
Example
General:text/plain; charset=UTF-8, image/png
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Consent.source[x]:sourceAttachment.language
Definition

The human language of the content. The value can be any valid value according to BCP 47.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages A human language.

Typecode
Requirements

Users need to be able to choose between the languages in a set of attachments.

Example
General:en-AU
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Consent.source[x]:sourceAttachment.data
Definition

The actual data of the attachment - a sequence of bytes, base64 encoded.

Control1..1
Typebase64Binary
Must Supporttrue
Requirements

The data needs to able to be transmitted inline.

Comments

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Consent.source[x]:sourceAttachment.url
Definition

A location where the data can be accessed.

Control0..1
Typeurl
Requirements

The data needs to be transmitted by reference.

Comments

If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

Example
General:http://www.acme.com/logo-small.png
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Consent.source[x]:sourceAttachment.size
Definition

The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

Control0..1
TypeunsignedInt
Requirements

Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

Comments

The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Consent.source[x]:sourceAttachment.hash
Definition

The calculated hash of the data using SHA-1. Represented using base64.

Control0..1
Typebase64Binary
Requirements

Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

Comments

The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Consent.source[x]:sourceAttachment.title
Definition

A label or set of text to display in place of the data.

Control0..1
Typestring
Requirements

Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

Example
General:Official Corporate Logo
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Consent.source[x]:sourceAttachment.creation
Definition

The date that the attachment was first created.

Control1..1
TypedateTime
Must Supporttrue
Requirements

This is often tracked as an integrity issue for use of the attachment.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Consent.policy
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.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. 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.

Control0..1
Typestring
32. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
33. 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
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())
34. Consent.policy.authority
Definition

Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.

Control0..1 This element is affected by the following invariants: ppc-1
Typeuri
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. 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.

Control0..1 This element is affected by the following invariants: ppc-1
Typeuri
Comments

This element is for discoverability / documentation and does not modify or qualify the policy rules.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Consent.policyRule
Definition

A reference to the specific base computable regulation or policy.

Control0..1 This element is affected by the following invariants: ppc-1
BindingThe codes SHALL be taken from ConsentPolicyRuleCodes; other codes may be used where these codes are not suitable Regulatory policy examples.

TypeCodeableConcept
Must Supporttrue
Requirements

Might be a unique identifier of a policy set in XACML, or other rules engine.

Comments

If the policyRule is absent, computable consent would need to be constructed from the elements of the Consent resource.

Fixed Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
    <code value="OPTIN"/>
    <display value="opt-in"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Consent.verification
Definition

Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. 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.

Control0..1
Typestring
39. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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.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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
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())
41. Consent.verification.verified
Definition

Has the instruction been verified.

Control1..1
Typeboolean
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. Consent.verification.verifiedWith
Definition

Who verified the instruction (Patient, Relative or other Authorized Person).

Control0..1
TypeReference(Patient | RelatedPerson)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. Consent.verification.verificationDate
Definition

Date verification was collected.

Control0..1
TypedateTime
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Consent.provision
Definition

An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

Control0..1
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. 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.

Control0..1
Typestring
46. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
47. 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
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())
48. Consent.provision.type
Definition

Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.

Control0..1
BindingThe codes SHALL be taken from ConsentProvisionType How a rule statement is applied, such as adding additional consent or removing consent.

Typecode
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. Consent.provision.period
Definition

The timeframe in this rule is valid.

Control0..1
TypePeriod
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. Consent.provision.actor
Definition

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').

Control0..*
TypeBackboneElement
Meaning if MissingThere is no specific actor associated with the exception
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. 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.

Control0..1
Typestring
52. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
53. 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
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())
54. Consent.provision.actor.role
Definition

How the individual is involved in the resources content that is described in the exception.

Control1..1
BindingThe codes SHALL be taken from SecurityRoleType; other codes may be used where these codes are not suitable How an actor is involved in the consent considerations.

TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. 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').

Control1..1
TypeReference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. Consent.provision.action
Definition

Actions controlled by this Rule.

Control0..*
BindingFor example codes, see ConsentActionCodes Detailed codes for the consent action.

TypeCodeableConcept
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'.

Meaning if Missingall actions
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. Consent.provision.securityLabel
Definition

A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System.

TypeCoding
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. Consent.provision.purpose
Definition

The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.

Control0..*
BindingThe codes SHALL be taken from PurposeOfUse; other codes may be used where these codes are not suitable What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.

TypeCoding
Comments

When the purpose of use tag is on the data, access request purpose of use shall not conflict.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. 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.

Control0..*
BindingThe codes SHALL be taken from ConsentContentClass; other codes may be used where these codes are not suitable The class (type) of information a consent rule covers.

TypeCoding
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. Consent.provision.code
Definition

If this code is found in an instance, then the rule applies.

Control0..*
BindingFor example codes, see ConsentContentCodes If this code is found in an instance, then the exception applies.

TypeCodeableConcept
Comments

Typical use of this is a Document code with class = CDA.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. Consent.provision.dataPeriod
Definition

Clinical or Operational Relevant period of time that bounds the data controlled by this rule.

Control0..1
TypePeriod
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. Consent.provision.data
Definition

The resources controlled by this rule if specific resources are referenced.

Control0..*
TypeBackboneElement
Meaning if Missingall data
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. 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.

Control0..1
Typestring
64. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
65. 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, user content, modifiers
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.

InvariantsDefined on this element
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())
66. Consent.provision.data.meaning
Definition

How the resource reference is interpreted when testing consent restrictions.

Control1..1
BindingThe codes SHALL be taken from ConsentDataMeaning How a resource reference is interpreted when testing consent restrictions.

Typecode
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
67. Consent.provision.data.reference
Definition

A reference to a specific resource that defines which resources are covered by this consent.

Control1..1
TypeReference(Resource)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. Consent.provision.provision
Definition

Rules which provide exceptions to the base rule or subrules.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Consent#Consent.provision
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))