A record of a healthcare consumer’s policy 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.
Consent | I | Consent | There are no (further) constraints on this element Element idConsent A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time DefinitionA record of a healthcare consumer’s policy 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. 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.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idConsent.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
|
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idConsent.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idConsent.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idConsent.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language. Common Languages (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idConsent.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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. 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 in formation is added later.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idConsent.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idConsent.identifier Identifier for this record (external references) DefinitionUnique identifier for this copy of the Consent Statement. This identifier is 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.
General { "system": "urn:ietf:rfc:3986", "value": "Local eCMS identifier" } Mappings
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.identifier.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.identifier.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idConsent.identifier.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idConsent.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idConsent.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
General http://www.acme.com/identifiers/patient Mappings
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idConsent.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
assigner | Σ I | 0..1 | Reference(CareConnect-Organization-1) | Element idConsent.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) Constraints
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idConsent.status draft | proposed | active | rejected | inactive | entered-in-error DefinitionIndicates the current state of this consent. The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive. 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. Indicates the state of the consent ConsentState (required)Constraints
|
category | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idConsent.category Classification of the consent statement - for indexing/retrieval DefinitionA classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A classification of the type of consents found in a consent statement Consent Category Codes (example)Constraints
|
patient | Σ I | 1..1 | Reference(CareConnect-Patient-1) | Element idConsent.patient Who the consent applies to DefinitionThe patient/healthcare consumer to whom this consent applies. Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person. Reference(CareConnect-Patient-1) Constraints
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.period Period that this consent applies DefinitionRelevant time or time-period when this Consent is applicable. This can be a subset of the period of the original statement. all date ranges included
|
dateTime | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idConsent.dateTime When this Consent was created or indexed DefinitionWhen this Consent was issued / created / indexed. This is not the time of the original consent, but the time that this statement was made or derived.
|
consentingParty | Σ I | 0..* | Reference(CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1) | Element idConsent.consentingParty Who is agreeing to the policy and exceptions Alternate namesconsentor DefinitionEither 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. 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. Reference(CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1) Constraints
|
actor | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.actor Who|what controlled by this consent (or group, by role) DefinitionWho or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). There is no specific actor associated with the consent
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.actor.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.actor.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.actor.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
role | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idConsent.actor.role How the actor is involved DefinitionHow the individual is involved in the resources content that is described in the consent. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. How an actor is involved in the consent considerations SecurityRoleType (extensible)Constraints
| |
reference | I | 1..1 | Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) | Element idConsent.actor.reference Resource for the actor (or group, by role) DefinitionThe resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) Constraints
|
action | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idConsent.action Actions controlled by this consent DefinitionActions controlled by this consent. 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'. all actions Detailed codes for the consent action. Consent Action Codes (example)Constraints
|
organization | Σ I | 0..* | Reference(CareConnect-Organization-1) | Element idConsent.organization Custodian of the consent Alternate namescustodian DefinitionThe organization that manages the consent, and the framework within which it is executed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-Organization-1) Constraints
|
source[x] | Σ | 0..1 | There are no (further) constraints on this element Element idConsent.source[x] Source from which this consent is taken DefinitionThe 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. 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.
| |
sourceAttachment | Attachment | Data type | ||
sourceIdentifier | Identifier | Data type | ||
sourceReference | Reference(DocumentReference | QuestionnaireResponse | CareConnect-Contract-1 | CareConnect-Consent-1) | Data type Reference(DocumentReference | QuestionnaireResponse | CareConnect-Contract-1 | CareConnect-Consent-1) | ||
policy | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.policy Policies covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.policy.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.policy.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.policy.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
authority | I | 0..1 | uri | There are no (further) constraints on this element Element idConsent.policy.authority Enforcement source for policy DefinitionEntity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
uri | I | 0..1 | uri | There are no (further) constraints on this element Element idConsent.policy.uri Specific policy covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. This element is for discoverability / documentation, and does not modify or qualify the policy rules.
|
policyRule | Σ I | 0..1 | uri | There are no (further) constraints on this element Element idConsent.policyRule Policy that this consents to DefinitionA referece to the specific computable policy. Might be a unique identifier of a policy set in XACML, or other rules engine. If the policy reference is not known, the resource cannot be processed. Where the reference is absent, there is no particular policy other than what is expressed directly in the consent resource.
|
securityLabel | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.securityLabel Security Labels that define affected resources DefinitionA set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels. 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. Not all of the security labels make sense for use in this element (may define a narrower value set?). Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
purpose | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.purpose Context of activities for which the agreement is made DefinitionThe context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent. This element is for discoverability / documentation, and does not modify or qualify the policy (e.g. the policy itself describes the purposes for which it applies). What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels PurposeOfUse (extensible)Constraints
|
dataPeriod | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.dataPeriod Timeframe for data controlled by this consent DefinitionClinical or Operational Relevant period of time that bounds the data controlled by this consent. 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.
|
data | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.data Data controlled by this consent DefinitionThe resources controlled by this consent, if specific resources are referenced. all data
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.data.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.data.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.data.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
meaning | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idConsent.data.meaning instance | related | dependents | authoredby DefinitionHow the resource reference is interpreted when testing consent restrictions. Note that FHIR strings may not exceed 1MB in size How a resource reference is interpreted when testing consent restrictions ConsentDataMeaning (required)Constraints
|
reference | Σ I | 1..1 | Reference(Resource) | There are no (further) constraints on this element Element idConsent.data.reference The actual data reference DefinitionA reference to a specific resource that defines which resources are covered by this consent. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
except | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.except Additional rule - addition or removal of permissions DefinitionAn exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.except.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idConsent.except.type deny | permit DefinitionAction to take - permit or deny - when the exception conditions are met. Note that FHIR strings may not exceed 1MB in size How an exception statement is applied, such as adding additional consent or removing consent ConsentExceptType (required)Constraints
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.except.period Timeframe for this exception DefinitionThe timeframe in this exception is valid. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
actor | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.except.actor Who|what controlled by this exception (or group, by role) DefinitionWho or what is controlled by this Exception. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). There is no specific actor associated with the exception
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.except.actor.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.actor.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.actor.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
role | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idConsent.except.actor.role How the actor is involved DefinitionHow the individual is involved in the resources content that is described in the exception. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. How an actor is involved in the consent considerations SecurityRoleType (extensible)Constraints
| |
reference | I | 1..1 | Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) | Element idConsent.except.actor.reference Resource for the actor (or group, by role) DefinitionThe resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) Constraints
|
action | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idConsent.except.action Actions controlled by this exception DefinitionActions controlled by this Exception. 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'. all actions Detailed codes for the consent action. Consent Action Codes (example)Constraints
|
securityLabel | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.except.securityLabel Security Labels that define affected resources DefinitionA set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels. 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. Not all of the security labels make sense for use in this element (may define a narrower value set?). Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
purpose | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.except.purpose Context of activities covered by this exception DefinitionThe context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception. E.g. if the purpose is 'research', then the operational context must be research, in order for the consent to apply. Not all of the security labels make sense for use in this element (may define a narrower value set?). What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels PurposeOfUse (extensible)Constraints
|
class | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.except.class e.g. Resource Type, Profile, or CDA etc DefinitionThe class of information covered by this exception. 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. 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. The class (type) of information a consent rule covers Consent Content Class (extensible)Constraints
|
code | Σ | 0..* | Coding | There are no (further) constraints on this element Element idConsent.except.code e.g. LOINC or SNOMED CT code, etc in the content DefinitionIf this code is found in an instance, then the exception applies. Typical use of this is a Document code with class = CDA. If this code is found in an instance, then the exception applies Consent Content Codes (example)Constraints
|
dataPeriod | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.except.dataPeriod Timeframe for data controlled by this exception DefinitionClinical or Operational Relevant period of time that bounds the data controlled by this exception. 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.
|
data | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.except.data Data controlled by this exception DefinitionThe resources controlled by this exception, if specific resources are referenced. all data
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.except.data.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.data.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.data.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
meaning | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idConsent.except.data.meaning instance | related | dependents | authoredby DefinitionHow the resource reference is interpreted when testing consent restrictions. Note that FHIR strings may not exceed 1MB in size How a resource reference is interpreted when testing consent restrictions ConsentDataMeaning (required)Constraints
|
reference | Σ I | 1..1 | Reference(Resource) | There are no (further) constraints on this element Element idConsent.except.data.reference The actual data reference DefinitionA reference to a specific resource that defines which resources are covered by this consent. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Consent | I | Consent | There are no (further) constraints on this element Element idConsent A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time DefinitionA record of a healthcare consumer’s policy 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. 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.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idConsent.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
|
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idConsent.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idConsent.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idConsent.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language. Common Languages (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idConsent.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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. 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 in formation is added later.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idConsent.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idConsent.identifier Identifier for this record (external references) DefinitionUnique identifier for this copy of the Consent Statement. This identifier is 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.
General { "system": "urn:ietf:rfc:3986", "value": "Local eCMS identifier" } Mappings
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.identifier.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.identifier.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idConsent.identifier.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idConsent.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idConsent.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
General http://www.acme.com/identifiers/patient Mappings
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idConsent.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
assigner | Σ I | 0..1 | Reference(CareConnect-Organization-1) | Element idConsent.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) Constraints
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idConsent.status draft | proposed | active | rejected | inactive | entered-in-error DefinitionIndicates the current state of this consent. The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive. 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. Indicates the state of the consent ConsentState (required)Constraints
|
category | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idConsent.category Classification of the consent statement - for indexing/retrieval DefinitionA classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A classification of the type of consents found in a consent statement Consent Category Codes (example)Constraints
|
patient | Σ I | 1..1 | Reference(CareConnect-Patient-1) | Element idConsent.patient Who the consent applies to DefinitionThe patient/healthcare consumer to whom this consent applies. Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person. Reference(CareConnect-Patient-1) Constraints
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.period Period that this consent applies DefinitionRelevant time or time-period when this Consent is applicable. This can be a subset of the period of the original statement. all date ranges included
|
dateTime | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idConsent.dateTime When this Consent was created or indexed DefinitionWhen this Consent was issued / created / indexed. This is not the time of the original consent, but the time that this statement was made or derived.
|
consentingParty | Σ I | 0..* | Reference(CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1) | Element idConsent.consentingParty Who is agreeing to the policy and exceptions Alternate namesconsentor DefinitionEither 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. 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. Reference(CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1) Constraints
|
actor | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.actor Who|what controlled by this consent (or group, by role) DefinitionWho or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). There is no specific actor associated with the consent
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.actor.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.actor.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.actor.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
role | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idConsent.actor.role How the actor is involved DefinitionHow the individual is involved in the resources content that is described in the consent. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. How an actor is involved in the consent considerations SecurityRoleType (extensible)Constraints
| |
reference | I | 1..1 | Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) | Element idConsent.actor.reference Resource for the actor (or group, by role) DefinitionThe resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) Constraints
|
action | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idConsent.action Actions controlled by this consent DefinitionActions controlled by this consent. 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'. all actions Detailed codes for the consent action. Consent Action Codes (example)Constraints
|
organization | Σ I | 0..* | Reference(CareConnect-Organization-1) | Element idConsent.organization Custodian of the consent Alternate namescustodian DefinitionThe organization that manages the consent, and the framework within which it is executed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-Organization-1) Constraints
|
source[x] | Σ | 0..1 | There are no (further) constraints on this element Element idConsent.source[x] Source from which this consent is taken DefinitionThe 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. 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.
| |
sourceAttachment | Attachment | Data type | ||
sourceIdentifier | Identifier | Data type | ||
sourceReference | Reference(DocumentReference | QuestionnaireResponse | CareConnect-Contract-1 | CareConnect-Consent-1) | Data type Reference(DocumentReference | QuestionnaireResponse | CareConnect-Contract-1 | CareConnect-Consent-1) | ||
policy | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.policy Policies covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.policy.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.policy.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.policy.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
authority | I | 0..1 | uri | There are no (further) constraints on this element Element idConsent.policy.authority Enforcement source for policy DefinitionEntity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
uri | I | 0..1 | uri | There are no (further) constraints on this element Element idConsent.policy.uri Specific policy covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. This element is for discoverability / documentation, and does not modify or qualify the policy rules.
|
policyRule | Σ I | 0..1 | uri | There are no (further) constraints on this element Element idConsent.policyRule Policy that this consents to DefinitionA referece to the specific computable policy. Might be a unique identifier of a policy set in XACML, or other rules engine. If the policy reference is not known, the resource cannot be processed. Where the reference is absent, there is no particular policy other than what is expressed directly in the consent resource.
|
securityLabel | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.securityLabel Security Labels that define affected resources DefinitionA set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels. 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. Not all of the security labels make sense for use in this element (may define a narrower value set?). Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
purpose | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.purpose Context of activities for which the agreement is made DefinitionThe context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent. This element is for discoverability / documentation, and does not modify or qualify the policy (e.g. the policy itself describes the purposes for which it applies). What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels PurposeOfUse (extensible)Constraints
|
dataPeriod | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.dataPeriod Timeframe for data controlled by this consent DefinitionClinical or Operational Relevant period of time that bounds the data controlled by this consent. 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.
|
data | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.data Data controlled by this consent DefinitionThe resources controlled by this consent, if specific resources are referenced. all data
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.data.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.data.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.data.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
meaning | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idConsent.data.meaning instance | related | dependents | authoredby DefinitionHow the resource reference is interpreted when testing consent restrictions. Note that FHIR strings may not exceed 1MB in size How a resource reference is interpreted when testing consent restrictions ConsentDataMeaning (required)Constraints
|
reference | Σ I | 1..1 | Reference(Resource) | There are no (further) constraints on this element Element idConsent.data.reference The actual data reference DefinitionA reference to a specific resource that defines which resources are covered by this consent. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
except | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.except Additional rule - addition or removal of permissions DefinitionAn exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.except.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idConsent.except.type deny | permit DefinitionAction to take - permit or deny - when the exception conditions are met. Note that FHIR strings may not exceed 1MB in size How an exception statement is applied, such as adding additional consent or removing consent ConsentExceptType (required)Constraints
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.except.period Timeframe for this exception DefinitionThe timeframe in this exception is valid. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
actor | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.except.actor Who|what controlled by this exception (or group, by role) DefinitionWho or what is controlled by this Exception. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). There is no specific actor associated with the exception
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.except.actor.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.actor.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.actor.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
role | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idConsent.except.actor.role How the actor is involved DefinitionHow the individual is involved in the resources content that is described in the exception. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. How an actor is involved in the consent considerations SecurityRoleType (extensible)Constraints
| |
reference | I | 1..1 | Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) | Element idConsent.except.actor.reference Resource for the actor (or group, by role) DefinitionThe resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) Constraints
|
action | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idConsent.except.action Actions controlled by this exception DefinitionActions controlled by this Exception. 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'. all actions Detailed codes for the consent action. Consent Action Codes (example)Constraints
|
securityLabel | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.except.securityLabel Security Labels that define affected resources DefinitionA set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels. 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. Not all of the security labels make sense for use in this element (may define a narrower value set?). Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
purpose | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.except.purpose Context of activities covered by this exception DefinitionThe context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception. E.g. if the purpose is 'research', then the operational context must be research, in order for the consent to apply. Not all of the security labels make sense for use in this element (may define a narrower value set?). What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels PurposeOfUse (extensible)Constraints
|
class | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.except.class e.g. Resource Type, Profile, or CDA etc DefinitionThe class of information covered by this exception. 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. 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. The class (type) of information a consent rule covers Consent Content Class (extensible)Constraints
|
code | Σ | 0..* | Coding | There are no (further) constraints on this element Element idConsent.except.code e.g. LOINC or SNOMED CT code, etc in the content DefinitionIf this code is found in an instance, then the exception applies. Typical use of this is a Document code with class = CDA. If this code is found in an instance, then the exception applies Consent Content Codes (example)Constraints
|
dataPeriod | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.except.dataPeriod Timeframe for data controlled by this exception DefinitionClinical or Operational Relevant period of time that bounds the data controlled by this exception. 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.
|
data | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.except.data Data controlled by this exception DefinitionThe resources controlled by this exception, if specific resources are referenced. all data
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.except.data.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.data.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.data.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
meaning | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idConsent.except.data.meaning instance | related | dependents | authoredby DefinitionHow the resource reference is interpreted when testing consent restrictions. Note that FHIR strings may not exceed 1MB in size How a resource reference is interpreted when testing consent restrictions ConsentDataMeaning (required)Constraints
|
reference | Σ I | 1..1 | Reference(Resource) | There are no (further) constraints on this element Element idConsent.except.data.reference The actual data reference DefinitionA reference to a specific resource that defines which resources are covered by this consent. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Consent | I | Consent | There are no (further) constraints on this element Element idConsent A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time DefinitionA record of a healthcare consumer’s policy 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. 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.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idConsent.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
|
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idConsent.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idConsent.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idConsent.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language. Common Languages (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idConsent.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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. 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 in formation is added later.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idConsent.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idConsent.identifier Identifier for this record (external references) DefinitionUnique identifier for this copy of the Consent Statement. This identifier is 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.
General { "system": "urn:ietf:rfc:3986", "value": "Local eCMS identifier" } Mappings
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.identifier.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.identifier.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idConsent.identifier.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idConsent.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idConsent.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
General http://www.acme.com/identifiers/patient Mappings
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idConsent.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
assigner | Σ I | 0..1 | Reference(CareConnect-Organization-1) | Element idConsent.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) Constraints
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idConsent.status draft | proposed | active | rejected | inactive | entered-in-error DefinitionIndicates the current state of this consent. The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive. 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. Indicates the state of the consent ConsentState (required)Constraints
|
category | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idConsent.category Classification of the consent statement - for indexing/retrieval DefinitionA classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A classification of the type of consents found in a consent statement Consent Category Codes (example)Constraints
|
patient | Σ I | 1..1 | Reference(CareConnect-Patient-1) | Element idConsent.patient Who the consent applies to DefinitionThe patient/healthcare consumer to whom this consent applies. Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person. Reference(CareConnect-Patient-1) Constraints
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.period Period that this consent applies DefinitionRelevant time or time-period when this Consent is applicable. This can be a subset of the period of the original statement. all date ranges included
|
dateTime | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idConsent.dateTime When this Consent was created or indexed DefinitionWhen this Consent was issued / created / indexed. This is not the time of the original consent, but the time that this statement was made or derived.
|
consentingParty | Σ I | 0..* | Reference(CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1) | Element idConsent.consentingParty Who is agreeing to the policy and exceptions Alternate namesconsentor DefinitionEither 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. 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. Reference(CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1) Constraints
|
actor | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.actor Who|what controlled by this consent (or group, by role) DefinitionWho or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). There is no specific actor associated with the consent
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.actor.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.actor.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.actor.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
role | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idConsent.actor.role How the actor is involved DefinitionHow the individual is involved in the resources content that is described in the consent. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. How an actor is involved in the consent considerations SecurityRoleType (extensible)Constraints
| |
reference | I | 1..1 | Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) | Element idConsent.actor.reference Resource for the actor (or group, by role) DefinitionThe resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) Constraints
|
action | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idConsent.action Actions controlled by this consent DefinitionActions controlled by this consent. 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'. all actions Detailed codes for the consent action. Consent Action Codes (example)Constraints
|
organization | Σ I | 0..* | Reference(CareConnect-Organization-1) | Element idConsent.organization Custodian of the consent Alternate namescustodian DefinitionThe organization that manages the consent, and the framework within which it is executed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-Organization-1) Constraints
|
source[x] | Σ | 0..1 | There are no (further) constraints on this element Element idConsent.source[x] Source from which this consent is taken DefinitionThe 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. 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.
| |
sourceAttachment | Attachment | Data type | ||
sourceIdentifier | Identifier | Data type | ||
sourceReference | Reference(DocumentReference | QuestionnaireResponse | CareConnect-Contract-1 | CareConnect-Consent-1) | Data type Reference(DocumentReference | QuestionnaireResponse | CareConnect-Contract-1 | CareConnect-Consent-1) | ||
policy | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.policy Policies covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.policy.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.policy.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.policy.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
authority | I | 0..1 | uri | There are no (further) constraints on this element Element idConsent.policy.authority Enforcement source for policy DefinitionEntity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
uri | I | 0..1 | uri | There are no (further) constraints on this element Element idConsent.policy.uri Specific policy covered by this consent DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. This element is for discoverability / documentation, and does not modify or qualify the policy rules.
|
policyRule | Σ I | 0..1 | uri | There are no (further) constraints on this element Element idConsent.policyRule Policy that this consents to DefinitionA referece to the specific computable policy. Might be a unique identifier of a policy set in XACML, or other rules engine. If the policy reference is not known, the resource cannot be processed. Where the reference is absent, there is no particular policy other than what is expressed directly in the consent resource.
|
securityLabel | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.securityLabel Security Labels that define affected resources DefinitionA set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels. 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. Not all of the security labels make sense for use in this element (may define a narrower value set?). Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
purpose | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.purpose Context of activities for which the agreement is made DefinitionThe context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent. This element is for discoverability / documentation, and does not modify or qualify the policy (e.g. the policy itself describes the purposes for which it applies). What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels PurposeOfUse (extensible)Constraints
|
dataPeriod | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.dataPeriod Timeframe for data controlled by this consent DefinitionClinical or Operational Relevant period of time that bounds the data controlled by this consent. 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.
|
data | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.data Data controlled by this consent DefinitionThe resources controlled by this consent, if specific resources are referenced. all data
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.data.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.data.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.data.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
meaning | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idConsent.data.meaning instance | related | dependents | authoredby DefinitionHow the resource reference is interpreted when testing consent restrictions. Note that FHIR strings may not exceed 1MB in size How a resource reference is interpreted when testing consent restrictions ConsentDataMeaning (required)Constraints
|
reference | Σ I | 1..1 | Reference(Resource) | There are no (further) constraints on this element Element idConsent.data.reference The actual data reference DefinitionA reference to a specific resource that defines which resources are covered by this consent. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
except | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.except Additional rule - addition or removal of permissions DefinitionAn exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.except.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idConsent.except.type deny | permit DefinitionAction to take - permit or deny - when the exception conditions are met. Note that FHIR strings may not exceed 1MB in size How an exception statement is applied, such as adding additional consent or removing consent ConsentExceptType (required)Constraints
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.except.period Timeframe for this exception DefinitionThe timeframe in this exception is valid. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
actor | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.except.actor Who|what controlled by this exception (or group, by role) DefinitionWho or what is controlled by this Exception. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). There is no specific actor associated with the exception
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.except.actor.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.actor.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.actor.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
role | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idConsent.except.actor.role How the actor is involved DefinitionHow the individual is involved in the resources content that is described in the exception. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. How an actor is involved in the consent considerations SecurityRoleType (extensible)Constraints
| |
reference | I | 1..1 | Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) | Element idConsent.except.actor.reference Resource for the actor (or group, by role) DefinitionThe resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) Constraints
|
action | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idConsent.except.action Actions controlled by this exception DefinitionActions controlled by this Exception. 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'. all actions Detailed codes for the consent action. Consent Action Codes (example)Constraints
|
securityLabel | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.except.securityLabel Security Labels that define affected resources DefinitionA set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels. 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. Not all of the security labels make sense for use in this element (may define a narrower value set?). Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
purpose | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.except.purpose Context of activities covered by this exception DefinitionThe context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception. E.g. if the purpose is 'research', then the operational context must be research, in order for the consent to apply. Not all of the security labels make sense for use in this element (may define a narrower value set?). What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels PurposeOfUse (extensible)Constraints
|
class | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idConsent.except.class e.g. Resource Type, Profile, or CDA etc DefinitionThe class of information covered by this exception. 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. 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. The class (type) of information a consent rule covers Consent Content Class (extensible)Constraints
|
code | Σ | 0..* | Coding | There are no (further) constraints on this element Element idConsent.except.code e.g. LOINC or SNOMED CT code, etc in the content DefinitionIf this code is found in an instance, then the exception applies. Typical use of this is a Document code with class = CDA. If this code is found in an instance, then the exception applies Consent Content Codes (example)Constraints
|
dataPeriod | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idConsent.except.dataPeriod Timeframe for data controlled by this exception DefinitionClinical or Operational Relevant period of time that bounds the data controlled by this exception. 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.
|
data | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idConsent.except.data Data controlled by this exception DefinitionThe resources controlled by this exception, if specific resources are referenced. all data
|
id | 0..1 | string | There are no (further) constraints on this element Element idConsent.except.data.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.data.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idConsent.except.data.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. 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.
|
meaning | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idConsent.except.data.meaning instance | related | dependents | authoredby DefinitionHow the resource reference is interpreted when testing consent restrictions. Note that FHIR strings may not exceed 1MB in size How a resource reference is interpreted when testing consent restrictions ConsentDataMeaning (required)Constraints
|
reference | Σ I | 1..1 | Reference(Resource) | There are no (further) constraints on this element Element idConsent.except.data.reference The actual data reference DefinitionA reference to a specific resource that defines which resources are covered by this consent. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Consent | .. | |
Consent.identifier | .. | |
Consent.identifier.assigner | Reference(CareConnect-Organization-1) | .. |
Consent.patient | Reference(CareConnect-Patient-1) | .. |
Consent.consentingParty | Reference(CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1) | .. |
Consent.actor | .. | |
Consent.actor.reference | Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) | .. |
Consent.organization | Reference(CareConnect-Organization-1) | .. |
Consent.source[x] | Reference(DocumentReference | QuestionnaireResponse | CareConnect-Contract-1 | CareConnect-Consent-1), Attachment, Identifier | .. |
Consent.except | .. | |
Consent.except.actor | .. | |
Consent.except.actor.reference | Reference(Device | Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1) | .. |
There is no specific guidance for this profile.