Resource Profile: Consent - PowerOfAttorney

There are no (further) constraints on this element

Element id

Consent.category

Short description

Classification of the consent statement - for indexing/retrieval

Definition

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

Comments

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.

Data type

ConsentCategoryCodes (example)

Binding

A classification of the type of consents found in a consent statement.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.code
w5: FiveWs.class
v2: CON-2 (Consent Type - CWE using table HL70496)

0..1

There are no (further) constraints on this element

Element id

Consent.category.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.category.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.category.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Consent.category.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.category.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Consent.category.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

Consent.category.coding.version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.category.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.category.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

Consent.category.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

Consent.category.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Reference(PatientDataAccess)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

subject

S Σ C

1..1

Element id

Consent.subject

Short description

Who the consent applies to

Definition

The patient/healthcare practitioner or group of persons to whom this consent applies.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (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.

Data type

Reference(PatientDataAccess)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.subject
w5: FiveWs.subject[x]

0..1

There are no (further) constraints on this element

Element id

Consent.subject.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.subject.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

S Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.subject.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Consent.subject.type

Short description

Type the reference refers to (e.g. "Patient") - must be a resource in resources

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

identifier

S Σ C

0..1

Element id

Consent.subject.identifier

Short description

Logical reference, when literal reference is not known

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists()
ndi-personal-identity-number-value-1: A Swedish personal identity number (sv: personnummer) should follow format 198001032385
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])\\d{4}$') or system != 'http://electronichealth.se/identifier/personnummer'
ndi-coordination-number-value-1: A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])([6-9][1-9])\\d{4}$') or system != 'http://electronichealth.se/identifier/samordningsnummer'

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

0..1

There are no (further) constraints on this element

Element id

Consent.subject.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.subject.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Consent.subject.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Consent.subject.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

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.

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Consent.subject.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Requirements

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.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.subject.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

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 http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ident-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.subject.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

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

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.subject.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.subject.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

date

S Σ

0..1

date

There are no (further) constraints on this element

Element id

Consent.date

Short description

Fully executed date of the consent

Definition

Date the consent instance was agreed to.

Data type

date

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.occurrence[x]
w5: FiveWs.recorded
v2: CON-13 (Consent Decision Date/Time – DTM)

period

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.period

Short description

Effective period for this Consent

Alternate names

period

Definition

Effective period for this Consent Resource and all provisions unless specified in that provision.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]

0..1

There are no (further) constraints on this element

Element id

Consent.period.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

start

S Σ C

1..1

Element id

Consent.period.start

Short description

Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ndi-dateTime-1: DateTime must be without timestamp
$this.toString().contains('T') = false

Mappings

rim: n/a
v2: DR.1
rim: ./low

end

S Σ C

0..1

Element id

Consent.period.end

Short description

End time with inclusive boundary, if not ongoing

Definition

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Comments

The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

Reference(PatientDataAccess | RelatedPersonDataAccess)

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ndi-dateTime-1: DateTime must be without timestamp
$this.toString().contains('T') = false

Mappings

rim: n/a
v2: DR.2
rim: ./high

grantor

S Σ C

1..1

Element id

Consent.grantor

Short description

Who is granting rights according to the policy and rules

Alternate names

grantor

Definition

The entity responsible for granting the rights listed in a Consent Directive.

Comments

Data type

Reference(PatientDataAccess | RelatedPersonDataAccess)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

0..1

There are no (further) constraints on this element

Element id

Consent.grantor.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.grantor.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

S Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.grantor.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Consent.grantor.type

Short description

Type the reference refers to (e.g. "Patient") - must be a resource in resources

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

identifier

S Σ C

0..1

Element id

Consent.grantor.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists()
ndi-personal-identity-number-value-1: A Swedish personal identity number (sv: personnummer) should follow format 198001032385
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])\\d{4}$') or system != 'http://electronichealth.se/identifier/personnummer'
ndi-coordination-number-value-1: A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])([6-9][1-9])\\d{4}$') or system != 'http://electronichealth.se/identifier/samordningsnummer'

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

0..1

There are no (further) constraints on this element

Element id

Consent.grantor.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.grantor.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Consent.grantor.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Consent.grantor.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Consent.grantor.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Requirements

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.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.grantor.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ident-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.grantor.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.grantor.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.grantor.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

Reference(RelatedPersonDataAccess)

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

grantee

S Σ C

1..1

Element id

Consent.grantee

Short description

Who is agreeing to the policy and rules

Alternate names

grantee

Definition

The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

Comments

In a fully computable consent, both grantee and grantor will be listed as actors within the consent. The Grantee and Grantor elements are for ease of search only.

Data type

Reference(RelatedPersonDataAccess)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

0..1

There are no (further) constraints on this element

Element id

Consent.grantee.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.grantee.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

S Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.grantee.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Consent.grantee.type

Short description

Type the reference refers to (e.g. "Patient") - must be a resource in resources

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

identifier

S Σ C

0..1

Element id

Consent.grantee.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists()
ndi-personal-identity-number-value-1: A Swedish personal identity number (sv: personnummer) should follow format 198001032385
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])\\d{4}$') or system != 'http://electronichealth.se/identifier/personnummer'
ndi-coordination-number-value-1: A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])([6-9][1-9])\\d{4}$') or system != 'http://electronichealth.se/identifier/samordningsnummer'

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

0..1

There are no (further) constraints on this element

Element id

Consent.grantee.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.grantee.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Consent.grantee.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Consent.grantee.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Consent.grantee.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Requirements

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.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.grantee.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ident-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.grantee.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.grantee.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.grantee.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

manager

0..*

Reference(HealthcareService | Organization | Patient | Practitioner)

There are no (further) constraints on this element

Element id

Consent.manager

Short description

Consent workflow management

Alternate names

manager

Definition

The actor that manages the consent through its lifecycle.

Comments

Data type

Reference(HealthcareService | Organization | Patient | Practitioner)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.witness

controller

0..*

Reference(HealthcareService | Organization | Patient | Practitioner)

There are no (further) constraints on this element

Element id

Consent.controller

Short description

Consent Enforcer

Alternate names

controller

Definition

The actor that controls/enforces the access according to the consent.

Comments

Data type

Reference(HealthcareService | Organization | Patient | Practitioner)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

sourceAttachment

0..*

Attachment

There are no (further) constraints on this element

Element id

Consent.sourceAttachment

Short description

Source from which this consent is taken

Definition

The source on which this consent statement is based. The source might be a scanned original paper form.

Comments

The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.

Data type

Attachment

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
att-1: If the Attachment has data, it SHALL have a contentType
data.empty() or contentType.exists()

Mappings

rim: n/a
v2: ED/RP
rim: ED
v2: Potential mappings to CON-5,6,7,8,16,19, 20-23

sourceReference

S C

1..1

Element id

Consent.sourceReference

Short description

Source from which this consent is taken

Definition

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.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: Potential mappings to CON-5,6,7,8,16,19, 20-23

0..1

There are no (further) constraints on this element

Element id

Consent.sourceReference.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.sourceReference.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.sourceReference.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Consent.sourceReference.type

Short description

Type the reference refers to (e.g. "Patient") - must be a resource in resources

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

identifier

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.sourceReference.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists()

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

display

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.sourceReference.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

regulatoryBasis

0..*

There are no (further) constraints on this element

Element id

Consent.regulatoryBasis

Short description

Regulations establishing base Consent

Definition

A set of codes that indicate the regulatory basis (if any) that this consent supports.

Comments

Data type

ConsentPolicyRuleCodes (example)

Binding

Regulatory policy examples

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CON-3 (Consent Form ID and Version – ST) Note: An implementation-specific requirement will be needed

policyBasis

0..1

There are no (further) constraints on this element

Element id

Consent.policyBasis

Short description

Computable version of the backing policy

Definition

A Reference or URL used to uniquely identify the policy the organization will enforce for this Consent. This Reference or URL should be specific to the version of the policy and should be dereferencable to a computable policy of some form.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

Consent.policyBasis.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.policyBasis.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Consent.policyBasis.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

0..1

There are no (further) constraints on this element

Element id

Consent.policyBasis.reference

Short description

Reference backing policy resource

Definition

A Reference that identifies the policy the organization will enforce for this Consent.

Comments

While any resource may be used, Consent, PlanDefinition and Contract would be most frequent

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

url

0..1

url

There are no (further) constraints on this element

Element id

Consent.policyBasis.url

Short description

URL to a computable backing policy

Definition

A URL that links to a computable version of the policy the organization will enforce for this Consent.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

policyText

0..*

There are no (further) constraints on this element

Element id

Consent.policyText

Short description

Human Readable Policy

Definition

A Reference to the human readable policy explaining the basis for the Consent.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

verification

SO Σ

0..*

Element id

Consent.verification

Short description

Consent Verified by patient or family

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Obligations

Code	Actor
SHALL:populate	power-of-attorney-source-actor-poa

0..1

There are no (further) constraints on this element

Element id

Consent.verification.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.verification.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Consent.verification.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

verified

S Σ

1..1

There are no (further) constraints on this element

Element id

Consent.verification.verified

Short description

Has been verified

Definition

Has the instruction been verified.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

verificationType

0..1

There are no (further) constraints on this element

Element id

Consent.verification.verificationType

Short description

Business case of verification

Definition

Extensible list of verification type starting with verification and re-validation.

Comments

This allows the verification element to hold multiple use cases including RelatedPerson verification of the Grantee decision and periodic re-validation of the consent.

Data type

ConsentVerificationCodes (example)

Binding

Types of Verification/Validation.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

0..1

There are no (further) constraints on this element

Element id

Consent.verification.verificationType.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.verification.verificationType.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.verification.verificationType.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Consent.verification.verificationType.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.verification.verificationType.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Consent.verification.verificationType.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

Consent.verification.verificationType.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.verification.verificationType.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.verification.verificationType.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

Consent.verification.verificationType.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

Consent.verification.verificationType.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

verifiedBy

0..1

Reference(Organization | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

Consent.verification.verifiedBy

Short description

Person conducting verification

Definition

The person who conducted the verification/validation of the Grantor decision.

Comments

Data type

Reference(Organization | Practitioner | PractitionerRole)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

verifiedWith

S C

1..1

Reference(Patient | RelatedPerson)

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith

Short description

Person who verified

Definition

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

Comments

Data type

Reference(Patient | RelatedPerson)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

0..1

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.type

Short description

Type the reference refers to (e.g. "Patient") - must be a resource in resources

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

identifier

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists()

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

0..1

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Requirements

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.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ident-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.verification.verifiedWith.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

verificationDate

0..*

There are no (further) constraints on this element

Element id

Consent.verification.verificationDate

Short description

When consent verified

Definition

Date(s) verification was collected.

Comments

Allows for history of verification/validation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

decision

S Σ ?!

1..1

codeBindingFixed Value

Element id

Consent.decision

Short description

deny | permit

Definition

Action to take - permit or deny - as default.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Data type

ConsentProvisionType (required)

Binding

Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

permit

Mappings

rim: n/a

provision

S Σ

1..*

There are no (further) constraints on this element

Element id

Consent.provision

Short description

Constraints to the base Consent.policyRule/Consent.policy

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

Consent.provision.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.provision.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Consent.provision.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.provision.period

Short description

Timeframe for this provision

Definition

Timeframe for this provision.

Comments

This is the bound effective time of the consent and should be in the base provision in the Consent resource.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CON-14&15 (Consent Effective Date Time, Consent End DateTime)

actor

0..*

There are no (further) constraints on this element

Element id

Consent.provision.actor

Short description

Who|what controlled by this provision (or group, by role)

Definition

Who or what is controlled by this provision. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').

Meaning when missing

There is no specific actor associated with the exception

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

Consent.provision.actor.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.provision.actor.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Consent.provision.actor.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

role

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Consent.provision.actor.role

Short description

How the actor is involved

Definition

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

Comments

Data type

ParticipationRoleType (extensible)

Binding

How an actor is involved in the consent considerations.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

reference

0..1

There are no (further) constraints on this element

Element id

Consent.provision.actor.reference

Short description

Resource for the actor (or group, by role)

Definition

The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

action

S Σ

1..*

CodeableConceptBinding

Element id

Consent.provision.action

Short description

Actions controlled by this provision

Definition

Actions controlled by this provision.

Comments

Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.

Meaning when missing

all actions

Data type

ps-permission-actions (required)

Binding

Detailed codes for the consent action.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

0..1

There are no (further) constraints on this element

Element id

Consent.provision.action.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.provision.action.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.provision.action.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Consent.provision.action.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.provision.action.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Consent.provision.action.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

Consent.provision.action.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.provision.action.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.provision.action.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

Consent.provision.action.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

Consent.provision.action.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

securityLabel

Σ C

0..*

There are no (further) constraints on this element

Element id

Consent.provision.securityLabel

Short description

Security Labels that define affected resources

Definition

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

Comments

If the consent specifies a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict.

Data type

SecurityLabelExamples (example)

Binding

Example Security Labels from the Healthcare Privacy and Security Classification System.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

purpose

Σ C

0..*

CodingBinding

There are no (further) constraints on this element

Element id

Consent.provision.purpose

Short description

Context of activities covered by this provision

Definition

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

Comments

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

Data type

http://terminology.hl7.org/ValueSet/v3-PurposeOfUse (extensible)

Binding

What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

documentType

S Σ C

0..*

CodingBinding

Element id

Consent.provision.documentType

Short description

EHDS data category

Definition

The documentType(s) covered by this provision. The type can be a CDA document, or some other type that indicates what sort of information the consent relates to.

Comments

Multiple types are or'ed together. The intention of the documentType element is that the codes refer to document types defined in a standard somewhere.

Data type

ndi-ehds-categories (required)

Binding

The document type a consent provision covers.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

0..1

There are no (further) constraints on this element

Element id

Consent.provision.documentType.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.provision.documentType.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Consent.provision.documentType.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

Consent.provision.documentType.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.provision.documentType.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.provision.documentType.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

Consent.provision.documentType.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

resourceType

Σ C

0..*

CodingBinding

There are no (further) constraints on this element

Element id

Consent.provision.resourceType

Short description

e.g. Resource Type, Profile, etc

Definition

The resourceType(s) covered by this provision. The type can be a FHIR resource type or a profile on a type that indicates what information the consent relates to.

Comments

Multiple types are or'ed together. The intention of the resourceType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.

Data type

Binding

The resource types a consent provision covers.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

code

0..*

There are no (further) constraints on this element

Element id

Consent.provision.code

Short description

e.g. LOINC or SNOMED CT code, etc. in the content

Definition

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

Comments

Data type

Binding

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

ConsentContentCodes (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

dataPeriod

S Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.provision.dataPeriod

Short description

Timeframe for data controlled by this provision

Definition

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

Comments

This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]

0..1

There are no (further) constraints on this element

Element id

Consent.provision.dataPeriod.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.provision.dataPeriod.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

start

S Σ C

0..1

Element id

Consent.provision.dataPeriod.start

Short description

Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ndi-dateTime-1: DateTime must be without timestamp
$this.toString().contains('T') = false

Mappings

rim: n/a
v2: DR.1
rim: ./low

end

S Σ C

0..1

Element id

Consent.provision.dataPeriod.end

Short description

End time with inclusive boundary, if not ongoing

Definition

Comments

The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ndi-dateTime-1: DateTime must be without timestamp
$this.toString().contains('T') = false

Mappings

rim: n/a
v2: DR.2
rim: ./high

data

S Σ

0..*

Element id

Consent.provision.data

Short description

Data controlled by this provision

Definition

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

Meaning when missing

all data

Data type

Slicing

Unordered, Open, by meaning(Value)

Slice data based on meaning

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Consent.provision.data.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.provision.data.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Consent.provision.data.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

meaning

S Σ

1..1

codeBinding

There are no (further) constraints on this element

Element id

Consent.provision.data.meaning

Short description

instance | related | dependents | authoredby

Definition

How the resource reference is interpreted when testing consent restrictions.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Data type

Binding

How a resource reference is interpreted when testing consent restrictions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

reference

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.provision.data.reference

Short description

The actual data reference

Definition

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

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

fromCaregiverOrUnit

S Σ

0..*

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit

Short description

Data controlled by this provision

Definition

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

Meaning when missing

all data

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

meaning

S Σ

1..1

codeBindingFixed Value

Element id

Consent.provision.data:fromCaregiverOrUnit.meaning

Short description

instance | related | dependents | authoredby

Definition

How the resource reference is interpreted when testing consent restrictions.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Data type

Binding

How a resource reference is interpreted when testing consent restrictions.

Reference(OrganizationDataAccess)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

authoredby

Mappings

rim: n/a

reference

S Σ C

1..1

Element id

Consent.provision.data:fromCaregiverOrUnit.reference

Short description

The actual data reference

Definition

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

Comments

Data type

Reference(OrganizationDataAccess)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

0..1

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

S Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.type

Short description

Type the reference refers to (e.g. "Patient") - must be a resource in resources

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

identifier

S Σ C

0..1

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists()
ndi-organization-identifier-value-1: A Swedish organization identifier (sv: organisationsnummer) should follow format 7999000057
value.matches('^\\d{6}\\d{4}$') or system != 'urn:oid:2.5.4.97'
ndi-personal-identity-number-value-1: A Swedish personal identity number (sv: personnummer) should follow format 198001032385
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])\\d{4}$') or system != 'http://electronichealth.se/identifier/personnummer'
ndi-coordination-number-value-1: A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])([6-9][1-9])\\d{4}$') or system != 'http://electronichealth.se/identifier/samordningsnummer'

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

0..1

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Requirements

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.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ C

1..1

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ident-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

Σ C

0..1

There are no (further) constraints on this element

Element id

Consent.provision.data:fromCaregiverOrUnit.reference.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

expression

0..1

Expression

There are no (further) constraints on this element

Element id

Consent.provision.expression

Short description

A computable expression of the consent

Definition

A computable (FHIRPath or other) definition of what is controlled by this consent.

Comments

Constraining the expression type for a specific implementation via profile is recommended

Data type

Expression

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
exp-2: The name must be a valid variable name in most computer languages
name.hasValue() implies name.matches('[A-Za-z][A-Za-z0-9\\_]{0,63}')
exp-1: An expression or a reference must be provided
expression.exists() or reference.exists()

Mappings

rim: n/a

provision

0..*

see (provision)

There are no (further) constraints on this element

Element id

Consent.provision.provision

Short description

Nested Exception Provisions

Definition

Provisions which provide exceptions to the base provision or subprovisions.

Consent C

Short A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time

Definition

Cardinality 0..*

Comments

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: n/a
rim: Entity. Role, or Act
rim: Entity, Role, or Act
workflow: Event
w5: infrastructure.information
v2: CON

Consent.id Σ

Short Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality 0..1

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Consent.meta Σ

Short Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality 0..1

Meta

Summary True

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.implicitRules Σ ?!

Short A set of rules under which this content was created

Definition

Cardinality 0..1

Modifier True

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Consent.language

Short Language of the resource content

Definition

The base language in which the resource is written.

Cardinality 0..1

IETF language tag for a human language

AllLanguages (required)

Additional bindings

CommonLanguages (starter)

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Consent.text S C

Short Description of POA

Definition

Cardinality 0..1

Narrative

Must Support True

Alias narrative, html, xhtml, display

Comments

Conditions The cardinality or value of this element may be affected by these constraints: dom-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

Consent.text.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.text.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.text.status S

Short generated | extensions | additional | empty

Definition

The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

Cardinality 1..1

The status of a resource narrative.

NarrativeStatus (required)

Must Support True

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed Value

generated

Mappings

rim: n/a
rim: N/A

Consent.text.div S C

Short Limited xhtml content

Definition

The actual narrative content, a stripped down version of XHTML.

Cardinality 1..1

xhtml

Must Support True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
htmlChecks()
txt-2: The narrative SHALL have some non-whitespace content
htmlChecks()

Mappings

rim: n/a
rim: N/A

Consent.contained C

Short Contained, inline Resources

Definition

Cardinality 0..*

Resource

Alias inline resources, anonymous resources, contained resources

Comments

Conditions The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5

Mappings

rim: n/a
rim: Entity. Role, or Act
rim: N/A

Consent.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.modifierExtension Σ ?! C

Short Extensions that cannot be ignored

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content

Requirements

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.identifier S Σ C

Short Identifier for this record (external references)

Definition

Unique identifier for this copy of the Consent Statement.

Cardinality 0..1

Must Support True

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists()

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Event.identifier
w5: FiveWs.identifier
v2: CON-4 (Consent Form Number – EI) Note: An implementation-specific requirement will be needed

Consent.status S Σ ?!

Short draft | active | inactive

Definition

Indicates the current state of this Consent resource.

Cardinality 1..1

Indicates the state of the consent.

poa-poa-statuses (required)

Must Support True

Modifier True

Summary True

Comments

This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.status
w5: FiveWs.status
v2: CON-11 (Consent Status – CNE using table HL70498)

Consent.category S Σ

Short Classification of the consent statement - for indexing/retrieval

Definition

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

Cardinality 0..*

ConsentCategoryCodes (example)

A classification of the type of consents found in a consent statement.

Must Support True

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.code
w5: FiveWs.class
v2: CON-2 (Consent Type - CWE using table HL70496)

Consent.category.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.category.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.category.coding S Σ C

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 1..1

Must Support True

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Consent.category.coding.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.category.coding.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.category.coding.system S Σ

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Consent.category.coding.version Σ

Short Version of the system - if relevant

Definition

Cardinality 0..1

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Consent.category.coding.code S Σ C

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Conditions The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Consent.category.coding.display Σ C

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 0..1

Summary True

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Conditions The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Consent.category.coding.userSelected Σ

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..1

Summary True

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Consent.category.text Σ

Short Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality 0..1

Summary True

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

Consent.subject S Σ C

Short Who the consent applies to

Definition

The patient/healthcare practitioner or group of persons to whom this consent applies.

Cardinality 1..1

Type Reference(PatientDataAccess)

Must Support True

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.subject
w5: FiveWs.subject[x]

Consent.subject.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.subject.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.subject.reference S Σ C

Short Literal reference, Relative, internal or absolute URL

Definition

Cardinality 0..1

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ref-2, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.subject.type Σ

Short Type the reference refers to (e.g. "Patient") - must be a resource in resources

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Cardinality 0..1

Aa resource (or, for logical models, the URI of the logical model).

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.subject.identifier S Σ C

Short Logical reference, when literal reference is not known

Definition

Cardinality 0..1

Must Support True

Summary True

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Conditions The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists()
ndi-personal-identity-number-value-1: A Swedish personal identity number (sv: personnummer) should follow format 198001032385
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])\\d{4}$') or system != 'http://electronichealth.se/identifier/personnummer'
ndi-coordination-number-value-1: A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])([6-9][1-9])\\d{4}$') or system != 'http://electronichealth.se/identifier/samordningsnummer'

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Consent.subject.identifier.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.subject.identifier.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.subject.identifier.use Σ ?!

Short usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Cardinality 0..1

Identifies the purpose for this identifier, if known .

Modifier True

Summary True

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

Consent.subject.identifier.type Σ

Short Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality 0..1

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Summary True

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

Consent.subject.identifier.system S Σ

Short The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Cardinality 1..1

Must Support True

Summary True

Requirements

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.

Comments

Identifier.system is always case sensitive.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples

General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Consent.subject.identifier.value S Σ C

Short The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality 1..1

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ident-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples

General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Consent.subject.identifier.period Σ C

Short Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Cardinality 0..1

Summary True

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

Consent.subject.identifier.assigner Σ C

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(Organization)

Summary True

Comments

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.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

Consent.subject.display Σ C

Short Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Cardinality 0..1

Summary True

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Conditions The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.date S Σ

Short Fully executed date of the consent

Definition

Date the consent instance was agreed to.

Cardinality 0..1

date

Must Support True

Summary True

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.occurrence[x]
w5: FiveWs.recorded
v2: CON-13 (Consent Decision Date/Time – DTM)

Consent.period S Σ C

Short Effective period for this Consent

Definition

Effective period for this Consent Resource and all provisions unless specified in that provision.

Cardinality 1..1

Must Support True

Summary True

Alias period

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]

Consent.period.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.period.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.period.start S Σ C

Short Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Cardinality 1..1

Must Support True

Summary True

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Conditions The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ndi-dateTime-1: DateTime must be without timestamp
$this.toString().contains('T') = false

Mappings

rim: n/a
v2: DR.1
rim: ./low

Consent.period.end S Σ C

Short End time with inclusive boundary, if not ongoing

Definition

Cardinality 0..1

Must Support True

Summary True

Comments

The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Conditions The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ndi-dateTime-1: DateTime must be without timestamp
$this.toString().contains('T') = false

Mappings

rim: n/a
v2: DR.2
rim: ./high

Consent.grantor S Σ C

Short Who is granting rights according to the policy and rules

Definition

The entity responsible for granting the rights listed in a Consent Directive.

Cardinality 1..1

Type Reference(PatientDataAccess | RelatedPersonDataAccess)

Must Support True

Summary True

Alias grantor

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Consent.grantor.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.grantor.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.grantor.reference S Σ C

Short Literal reference, Relative, internal or absolute URL

Definition

Cardinality 0..1

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ref-2, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.grantor.type Σ

Short Type the reference refers to (e.g. "Patient") - must be a resource in resources

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Cardinality 0..1

Aa resource (or, for logical models, the URI of the logical model).

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.grantor.identifier S Σ C

Short Logical reference, when literal reference is not known

Definition

Cardinality 0..1

Must Support True

Summary True

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Conditions The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists()
ndi-personal-identity-number-value-1: A Swedish personal identity number (sv: personnummer) should follow format 198001032385
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])\\d{4}$') or system != 'http://electronichealth.se/identifier/personnummer'
ndi-coordination-number-value-1: A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])([6-9][1-9])\\d{4}$') or system != 'http://electronichealth.se/identifier/samordningsnummer'

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Consent.grantor.identifier.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.grantor.identifier.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.grantor.identifier.use Σ ?!

Short usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Cardinality 0..1

Identifies the purpose for this identifier, if known .

Modifier True

Summary True

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

Consent.grantor.identifier.type Σ

Short Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality 0..1

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Summary True

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

Consent.grantor.identifier.system S Σ

Short The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Cardinality 1..1

Must Support True

Summary True

Requirements

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.

Comments

Identifier.system is always case sensitive.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples

General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Consent.grantor.identifier.value S Σ C

Short The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality 1..1

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ident-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples

General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Consent.grantor.identifier.period Σ C

Short Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Cardinality 0..1

Summary True

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

Consent.grantor.identifier.assigner Σ C

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(Organization)

Summary True

Comments

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.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

Consent.grantor.display Σ C

Short Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Cardinality 0..1

Summary True

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Conditions The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.grantee S Σ C

Short Who is agreeing to the policy and rules

Definition

The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

Cardinality 1..1

Type Reference(RelatedPersonDataAccess)

Must Support True

Summary True

Alias grantee

Comments

In a fully computable consent, both grantee and grantor will be listed as actors within the consent. The Grantee and Grantor elements are for ease of search only.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Consent.grantee.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.grantee.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.grantee.reference S Σ C

Short Literal reference, Relative, internal or absolute URL

Definition

Cardinality 0..1

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ref-2, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.grantee.type Σ

Short Type the reference refers to (e.g. "Patient") - must be a resource in resources

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Cardinality 0..1

Aa resource (or, for logical models, the URI of the logical model).

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.grantee.identifier S Σ C

Short Logical reference, when literal reference is not known

Definition

Cardinality 0..1

Must Support True

Summary True

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Conditions The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists()
ndi-personal-identity-number-value-1: A Swedish personal identity number (sv: personnummer) should follow format 198001032385
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])\\d{4}$') or system != 'http://electronichealth.se/identifier/personnummer'
ndi-coordination-number-value-1: A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])([6-9][1-9])\\d{4}$') or system != 'http://electronichealth.se/identifier/samordningsnummer'

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Consent.grantee.identifier.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.grantee.identifier.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.grantee.identifier.use Σ ?!

Short usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Cardinality 0..1

Identifies the purpose for this identifier, if known .

Modifier True

Summary True

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

Consent.grantee.identifier.type Σ

Short Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality 0..1

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Summary True

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

Consent.grantee.identifier.system S Σ

Short The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Cardinality 1..1

Must Support True

Summary True

Requirements

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.

Comments

Identifier.system is always case sensitive.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples

General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Consent.grantee.identifier.value S Σ C

Short The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality 1..1

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ident-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples

General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Consent.grantee.identifier.period Σ C

Short Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Cardinality 0..1

Summary True

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

Consent.grantee.identifier.assigner Σ C

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(Organization)

Summary True

Comments

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.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

Consent.grantee.display Σ C

Short Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Cardinality 0..1

Summary True

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Conditions The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.manager C

Short Consent workflow management

Definition

The actor that manages the consent through its lifecycle.

Cardinality 0..*

Type Reference(HealthcareService | Organization | Patient | Practitioner)

Alias manager

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.witness

Consent.controller C

Short Consent Enforcer

Definition

The actor that controls/enforces the access according to the consent.

Cardinality 0..*

Type Reference(HealthcareService | Organization | Patient | Practitioner)

Alias controller

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Consent.sourceAttachment C

Short Source from which this consent is taken

Definition

The source on which this consent statement is based. The source might be a scanned original paper form.

Cardinality 0..*

Attachment

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
att-1: If the Attachment has data, it SHALL have a contentType
data.empty() or contentType.exists()

Mappings

rim: n/a
v2: ED/RP
rim: ED
v2: Potential mappings to CON-5,6,7,8,16,19, 20-23

Consent.sourceReference S C

Short Source from which this consent is taken

Definition

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.

Cardinality 1..1

Type Reference(DocumentReference)

Must Support True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: Potential mappings to CON-5,6,7,8,16,19, 20-23

Consent.sourceReference.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.sourceReference.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.sourceReference.reference S Σ C

Short Literal reference, Relative, internal or absolute URL

Definition

Cardinality 1..1

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ref-2, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.sourceReference.type Σ

Short Type the reference refers to (e.g. "Patient") - must be a resource in resources

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Cardinality 0..1

Aa resource (or, for logical models, the URI of the logical model).

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.sourceReference.identifier Σ C

Short Logical reference, when literal reference is not known

Definition

Cardinality 0..1

Summary True

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Conditions The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists()

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Consent.sourceReference.display Σ C

Short Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Cardinality 0..1

Summary True

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Conditions The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.regulatoryBasis

Short Regulations establishing base Consent

Definition

A set of codes that indicate the regulatory basis (if any) that this consent supports.

Cardinality 0..*

ConsentPolicyRuleCodes (example)

Regulatory policy examples

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CON-3 (Consent Form ID and Version – ST) Note: An implementation-specific requirement will be needed

Consent.policyBasis

Short Computable version of the backing policy

Definition

Cardinality 0..1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Consent.policyBasis.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.policyBasis.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.policyBasis.modifierExtension Σ ?! C

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.policyBasis.reference C

Short Reference backing policy resource

Definition

A Reference that identifies the policy the organization will enforce for this Consent.

Cardinality 0..1

Type Reference(Resource)

Comments

While any resource may be used, Consent, PlanDefinition and Contract would be most frequent

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Consent.policyBasis.url

Short URL to a computable backing policy

Definition

A URL that links to a computable version of the policy the organization will enforce for this Consent.

Cardinality 0..1

url

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Consent.policyText C

Short Human Readable Policy

Definition

A Reference to the human readable policy explaining the basis for the Consent.

Cardinality 0..*

Type Reference(DocumentReference)

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Consent.verification SO Σ

Short Consent Verified by patient or family

Definition

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

Cardinality 0..*

Must Support True

Summary True

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Obligations

Code	Actor
SHALL:populate	power-of-attorney-source-actor-poa

Consent.verification.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.verification.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.verification.modifierExtension Σ ?! C

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.verification.verified S Σ

Short Has been verified

Definition

Has the instruction been verified.

Cardinality 1..1

Must Support True

Summary True

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Consent.verification.verificationType S

Short Business case of verification

Definition

Extensible list of verification type starting with verification and re-validation.

Cardinality 0..1

ConsentVerificationCodes (example)

Types of Verification/Validation.

Must Support True

Comments

This allows the verification element to hold multiple use cases including RelatedPerson verification of the Grantee decision and periodic re-validation of the consent.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

Consent.verification.verificationType.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.verification.verificationType.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.verification.verificationType.coding S Σ C

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 1..1

Must Support True

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Consent.verification.verificationType.coding.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.verification.verificationType.coding.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.verification.verificationType.coding.system S Σ

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Consent.verification.verificationType.coding.version Σ

Short Version of the system - if relevant

Definition

Cardinality 0..1

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Consent.verification.verificationType.coding.code S Σ C

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Conditions The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Consent.verification.verificationType.coding.display Σ C

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 0..1

Summary True

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Conditions The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Consent.verification.verificationType.coding.userSelected Σ

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..1

Summary True

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Consent.verification.verificationType.text Σ

Short Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality 0..1

Summary True

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

Consent.verification.verifiedBy C

Short Person conducting verification

Definition

The person who conducted the verification/validation of the Grantor decision.

Cardinality 0..1

Type Reference(Organization | Practitioner | PractitionerRole)

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Consent.verification.verifiedWith S C

Short Person who verified

Definition

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

Cardinality 1..1

Type Reference(Patient | RelatedPerson)

Must Support True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Consent.verification.verifiedWith.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.verification.verifiedWith.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.verification.verifiedWith.reference Σ C

Short Literal reference, Relative, internal or absolute URL

Definition

Cardinality 0..1

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ref-2, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.verification.verifiedWith.type Σ

Short Type the reference refers to (e.g. "Patient") - must be a resource in resources

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Cardinality 0..1

Aa resource (or, for logical models, the URI of the logical model).

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.verification.verifiedWith.identifier S Σ C

Short Logical reference, when literal reference is not known

Definition

Cardinality 1..1

Must Support True

Summary True

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Conditions The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists()

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Consent.verification.verifiedWith.identifier.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.verification.verifiedWith.identifier.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.verification.verifiedWith.identifier.use Σ ?!

Short usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Cardinality 0..1

Identifies the purpose for this identifier, if known .

Modifier True

Summary True

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

Consent.verification.verifiedWith.identifier.type Σ

Short Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality 0..1

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Summary True

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

Consent.verification.verifiedWith.identifier.system S Σ

Short The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Cardinality 1..1

Must Support True

Summary True

Requirements

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.

Comments

Identifier.system is always case sensitive.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples

General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Consent.verification.verifiedWith.identifier.value S Σ C

Short The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality 1..1

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ident-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples

General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Consent.verification.verifiedWith.identifier.period Σ C

Short Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Cardinality 0..1

Summary True

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

Consent.verification.verifiedWith.identifier.assigner Σ C

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(Organization)

Summary True

Comments

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.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

Consent.verification.verifiedWith.display Σ C

Short Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Cardinality 0..1

Summary True

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Conditions The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.verification.verificationDate

Short When consent verified

Definition

Date(s) verification was collected.

Cardinality 0..*

Comments

Allows for history of verification/validation.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Consent.decision S Σ ?!

Short deny | permit

Definition

Action to take - permit or deny - as default.

Cardinality 1..1

ConsentProvisionType (required)

Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.

Must Support True

Modifier True

Summary True

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed Value

permit

Mappings

rim: n/a

Consent.provision S Σ

Short Constraints to the base Consent.policyRule/Consent.policy

Definition

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

Cardinality 1..*

Must Support True

Summary True

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Consent.provision.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.provision.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.modifierExtension Σ ?! C

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.period Σ C

Short Timeframe for this provision

Definition

Timeframe for this provision.

Cardinality 0..1

Summary True

Comments

This is the bound effective time of the consent and should be in the base provision in the Consent resource.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CON-14&15 (Consent Effective Date Time, Consent End DateTime)

Consent.provision.actor

Short Who|what controlled by this provision (or group, by role)

Definition

Who or what is controlled by this provision. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').

Cardinality 0..*

Meaning when missing

There is no specific actor associated with the exception

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Consent.provision.actor.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.provision.actor.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.actor.modifierExtension Σ ?! C

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.actor.role

Short How the actor is involved

Definition

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

Cardinality 0..1

ParticipationRoleType (extensible)

How an actor is involved in the consent considerations.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

Consent.provision.actor.reference C

Short Resource for the actor (or group, by role)

Definition

The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').

Cardinality 0..1

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Consent.provision.action S Σ

Short Actions controlled by this provision

Definition

Actions controlled by this provision.

Cardinality 1..*

ps-permission-actions (required)

Detailed codes for the consent action.

Must Support True

Summary True

Comments

Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.

Meaning when missing

all actions

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

Consent.provision.action.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.provision.action.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.action.coding S Σ C

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 1..1

Must Support True

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Consent.provision.action.coding.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.provision.action.coding.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.action.coding.system S Σ

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Consent.provision.action.coding.version Σ

Short Version of the system - if relevant

Definition

Cardinality 0..1

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Consent.provision.action.coding.code S Σ C

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Conditions The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Consent.provision.action.coding.display Σ C

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 0..1

Summary True

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Conditions The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Consent.provision.action.coding.userSelected Σ

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..1

Summary True

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Consent.provision.action.text Σ

Short Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality 0..1

Summary True

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

Consent.provision.securityLabel Σ C

Short Security Labels that define affected resources

Definition

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

Cardinality 0..*

SecurityLabelExamples (example)

Example Security Labels from the Healthcare Privacy and Security Classification System.

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

Consent.provision.purpose Σ C

Short Context of activities covered by this provision

Definition

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

Cardinality 0..*

http://terminology.hl7.org/ValueSet/v3-PurposeOfUse (extensible)

What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.

Summary True

Comments

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

Consent.provision.documentType S Σ C

Short EHDS data category

Definition

The documentType(s) covered by this provision. The type can be a CDA document, or some other type that indicates what sort of information the consent relates to.

Cardinality 0..*

ndi-ehds-categories (required)

The document type a consent provision covers.

Must Support True

Summary True

Comments

Multiple types are or'ed together. The intention of the documentType element is that the codes refer to document types defined in a standard somewhere.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

Consent.provision.documentType.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.provision.documentType.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.documentType.system S Σ

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Consent.provision.documentType.version Σ

Short Version of the system - if relevant

Definition

Cardinality 0..1

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Consent.provision.documentType.code S Σ C

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Must Support True

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Conditions The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Consent.provision.documentType.display Σ C

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 0..1

Summary True

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Conditions The cardinality or value of this element may be affected by these constraints: cod-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Consent.provision.documentType.userSelected Σ

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..1

Summary True

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Consent.provision.resourceType Σ C

Short e.g. Resource Type, Profile, etc

Definition

The resourceType(s) covered by this provision. The type can be a FHIR resource type or a profile on a type that indicates what information the consent relates to.

Cardinality 0..*

The resource types a consent provision covers.

Summary True

Comments

Multiple types are or'ed together. The intention of the resourceType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text
code.exists().not() implies display.exists().not()

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

Consent.provision.code Σ

Short e.g. LOINC or SNOMED CT code, etc. in the content

Definition

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

Cardinality 0..*

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

ConsentContentCodes (example)

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

Consent.provision.dataPeriod S Σ C

Short Timeframe for data controlled by this provision

Definition

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

Cardinality 0..1

Must Support True

Summary True

Comments

This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]

Consent.provision.dataPeriod.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.provision.dataPeriod.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.dataPeriod.start S Σ C

Short Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Cardinality 0..1

Must Support True

Summary True

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Conditions The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ndi-dateTime-1: DateTime must be without timestamp
$this.toString().contains('T') = false

Mappings

rim: n/a
v2: DR.1
rim: ./low

Consent.provision.dataPeriod.end S Σ C

Short End time with inclusive boundary, if not ongoing

Definition

Cardinality 0..1

Must Support True

Summary True

Comments

The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Conditions The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ndi-dateTime-1: DateTime must be without timestamp
$this.toString().contains('T') = false

Mappings

rim: n/a
v2: DR.2
rim: ./high

Consent.provision.data S Σ

Short Data controlled by this provision

Definition

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

Cardinality 0..*

Must Support True

Summary True

Meaning when missing

all data

Unordered, Open, by meaning(Value)

Slice data based on meaning

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Consent.provision.data.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.provision.data.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.data.modifierExtension Σ ?! C

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.data.meaning S Σ

Short instance | related | dependents | authoredby

Definition

How the resource reference is interpreted when testing consent restrictions.

Cardinality 1..1

How a resource reference is interpreted when testing consent restrictions.

Must Support True

Summary True

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Consent.provision.data.reference S Σ C

Short The actual data reference

Definition

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

Cardinality 1..1

Type Reference(Resource)

Must Support True

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Consent.provision.data:fromCaregiverOrUnit S Σ

Short Data controlled by this provision

Definition

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

Cardinality 0..*

Must Support True

Summary True

Meaning when missing

all data

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Consent.provision.data:fromCaregiverOrUnit.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.provision.data:fromCaregiverOrUnit.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.data:fromCaregiverOrUnit.modifierExtension Σ ?! C

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.data:fromCaregiverOrUnit.meaning S Σ

Short instance | related | dependents | authoredby

Definition

How the resource reference is interpreted when testing consent restrictions.

Cardinality 1..1

How a resource reference is interpreted when testing consent restrictions.

Must Support True

Summary True

Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed Value

authoredby

Mappings

rim: n/a

Consent.provision.data:fromCaregiverOrUnit.reference S Σ C

Short The actual data reference

Definition

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

Cardinality 1..1

Type Reference(OrganizationDataAccess)

Must Support True

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Consent.provision.data:fromCaregiverOrUnit.reference.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.provision.data:fromCaregiverOrUnit.reference.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.data:fromCaregiverOrUnit.reference.reference S Σ C

Short Literal reference, Relative, internal or absolute URL

Definition

Cardinality 0..1

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ref-2, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.provision.data:fromCaregiverOrUnit.reference.type Σ

Short Type the reference refers to (e.g. "Patient") - must be a resource in resources

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Cardinality 0..1

Aa resource (or, for logical models, the URI of the logical model).

Summary True

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.provision.data:fromCaregiverOrUnit.reference.identifier S Σ C

Short Logical reference, when literal reference is not known

Definition

Cardinality 0..1

Must Support True

Summary True

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

Conditions The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists()
ndi-organization-identifier-value-1: A Swedish organization identifier (sv: organisationsnummer) should follow format 7999000057
value.matches('^\\d{6}\\d{4}$') or system != 'urn:oid:2.5.4.97'
ndi-personal-identity-number-value-1: A Swedish personal identity number (sv: personnummer) should follow format 198001032385
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])\\d{4}$') or system != 'http://electronichealth.se/identifier/personnummer'
ndi-coordination-number-value-1: A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399
value.matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(0[1-9]|1[0-2])([6-9][1-9])\\d{4}$') or system != 'http://electronichealth.se/identifier/samordningsnummer'

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Mappings

rim: n/a

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.use Σ ?!

Short usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Cardinality 0..1

Identifies the purpose for this identifier, if known .

Modifier True

Summary True

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.type Σ

Short Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality 0..1

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Summary True

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.system S Σ

Short The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

Cardinality 1..1

Must Support True

Summary True

Requirements

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.

Comments

Identifier.system is always case sensitive.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples

General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.value S Σ C

Short The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality 1..1

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ident-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples

General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.period Σ C

Short Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Cardinality 0..1

Summary True

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower or equal value than end
start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

Consent.provision.data:fromCaregiverOrUnit.reference.identifier.assigner Σ C

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(Organization)

Summary True

Comments

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.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
reference.exists() or identifier.exists() or display.exists() or extension.exists()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

Consent.provision.data:fromCaregiverOrUnit.reference.display Σ C

Short Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Cardinality 0..1

Summary True

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Conditions The cardinality or value of this element may be affected by these constraints: ref-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Consent.provision.expression C

Short A computable expression of the consent

Definition

A computable (FHIRPath or other) definition of what is controlled by this consent.

Cardinality 0..1