Resource Profile: Consent - Restriction

General information

Scope and Usage

This profile is used to express a patient restricting access to its health data. It is a profile of the base resource Consent. A Consent resource can be used as a restriction by setting the decision element to deny.

It can be used to express an opt out as well as more granular restrictions that specify what data cannot be accessed and whose access is being restricted. The restriction can optionally include an end date, meaning that it can be indefinite or end at a certain date and time.

Profile

RestrictionRe (Consent)	C		Consent	Element id Consent Short description 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 A record of a healthcare consumer’s choices or choices made on their behalf by a third party, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. Comments Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment and consent for research participation and data sharing. Data type Consent 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()` ndi-consent-date-2: If present, date SHALL have a lower or equal value than period.start `date.hasValue().not() or date <= period.start` ndi-consent-actors-1: If any of category codes is "restriction", the person whose access is being restricted (grantee) cannot be the same person as the one whose data the restriction concerns (subject). `(subject.identifier != grantee.identifier) or category.coding.all(code != 'restriction')` ndi-consent-actors-2: If any of category codes is "restriction", the person whose access is being restricted (grantee) cannot be the same person as the one is creating the restriction (grantor). `(grantor.identifier != grantee.identifier) or category.coding.all(code != 'restriction')` Mappings rim: n/a rim: Entity. Role, or Act rim: Entity, Role, or Act workflow: Event w5: infrastructure.information v2: CON
id	Σ	0..1	id	There are no (further) constraints on this element Element id Consent.id Short description 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. Comments Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. Data type id Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Consent.meta Short description 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. Data type Meta 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
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Consent.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id Consent.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding IETF language tag for a human language AllLanguages (required) Additional bindings CommonLanguages (starter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text	C	0..1	Narrative	There are no (further) constraints on this element Element id Consent.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative 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?
contained	C	0..*	Resource	There are no (further) constraints on this element Element id Consent.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Data type Resource 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
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Consent.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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..*	Extension	There are no (further) constraints on this element Element id Consent.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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
identifier	Σ C	0..*	Identifier	There are no (further) constraints on this element Element id Consent.identifier Short description Identifier for this record (external references) Definition Unique identifier for this copy of the Consent Statement. Comments This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same. Data type Identifier 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
status	S Σ ?!	1..1	codeBinding	Element id Consent.status Short description active \| inactive Definition Indicates the current state of this Consent resource. 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. Data type code Binding Indicates the state of the consent. re-restriction-statuses (required) 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)
category	S Σ	1..*	CodeableConceptBinding	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 CodeableConcept Binding A classification of the type of consents found in a consent statement. re-restriction-categories (required) 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)
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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	Coding	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 Coding 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: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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	uri	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 uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	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 string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ C	1..1	code	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 (10241024) characters in size Data type* code 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: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ C	0..1	string	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 (10241024) characters in size Data type* string 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: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	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 boolean 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	string	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 string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
subject	S Σ C	1..1	Reference(PatientDataAccess)	Element id Consent.subject Short description The patient whom the Restriction concerns 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]
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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	string	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 string 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 uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) 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	Identifier	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 Identifier 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
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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 code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) 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 CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) 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	uri	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 uri 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	string	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 string 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 123456 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	Period	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 Period 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	Reference(Organization)	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 Reference(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
display	Σ C	0..1	string	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 string 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 Σ C	0..1	date	Element id Consent.date Short description Date the restriction was created Definition The date when the grantor created the restriction. Can be before it was submitted to a server, e.g. by filling in a physical form Data type date Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ndi-consent-date-1: Date SHALL have a lower or equal value than today's date `$this <= today()` Mappings rim: n/a workflow: Event.occurrence[x] w5: FiveWs.recorded v2: CON-13 (Consent Decision Date/Time – DTM)
period	S Σ C	1..1	Period	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 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 Period 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"]
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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	dateTime	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 dateTime 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-consent-period-start-1: Period.start SHALL have a higher or equal value than today's date `$this >= today()` 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	dateTime	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 dateTime 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-consent-period-end-1: Period.end SHALL have a higher or equal value than today's date `$this >= today()` 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	Reference(PatientDataAccess \| PractitionerRole \| RelatedPerson)	Element id Consent.grantor Short description The individual that created the Restriction Alternate names grantor Definition The entity responsible for granting the rights listed in a Consent Directive. 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 \| PractitionerRole \| 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)
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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	string	There are no (further) constraints on this element Element id Consent.grantor.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 string 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	S Σ	1..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. 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 uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) 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	Identifier	Element id Consent.grantor.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 Identifier 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'` ndi-hsa-identifier-value-1: If identifier.system = urn:oid:1.2.752.29.4.19, value should follow format for HSA ID: SE1234567890-ABC1. Characters å, ä, ö, @ not valid. `value.matches('^SE[0-9]{10}-[A-za-z0-9]+$') or system != 'urn:oid:1.2.752.29.4.19'` 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
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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 code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) 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 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 CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) 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	uri	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 uri 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	string	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 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 string 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 123456 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	Period	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 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 Period 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	Reference(Organization)	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 Reference(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
display	Σ C	0..1	string	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 string 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	0..*	Reference(OrganizationDataAccess \| PatientDataAccess \| Practitioner \| RelatedPerson)	Element id Consent.grantee Short description The organization or individual whose access is being restricted 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(OrganizationDataAccess \| PatientDataAccess \| Practitioner \| 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)
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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	string	There are no (further) constraints on this element Element id Consent.grantee.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 string 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	S Σ	1..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. 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 uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) 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	Identifier	Element id Consent.grantee.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 Identifier 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'` 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-country-identifier-value-1: A country identifier should follow ISO-3166 format, e.g. SE `value.matches('^[A-Z]{2}$') or system != 'urn:iso:std:iso:3166'` 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
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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 code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) 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 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 CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) 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	uri	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 uri 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	string	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 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 string 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 123456 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	Period	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 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 Period 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	Reference(Organization)	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 Reference(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
display	Σ C	0..1	string	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 string 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	C	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 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(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	C	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 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(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	C	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	C	0..*	Reference(Consent \| Contract \| DocumentReference \| QuestionnaireResponse)	There are no (further) constraints on this element 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 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 Reference(Consent \| Contract \| DocumentReference \| QuestionnaireResponse) 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
regulatoryBasis	S	0..*	CodeableConceptBinding	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 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 CodeableConcept Binding Regulatory policy examples re-regulatory-bases-of-restriction (required) 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
id		0..1	string	There are no (further) constraints on this element Element id Consent.regulatoryBasis.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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Consent.regulatoryBasis.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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	Coding	There are no (further) constraints on this element Element id Consent.regulatoryBasis.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 Coding 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: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	string	There are no (further) constraints on this element Element id Consent.regulatoryBasis.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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Consent.regulatoryBasis.coding.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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	uri	There are no (further) constraints on this element Element id Consent.regulatoryBasis.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 uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id Consent.regulatoryBasis.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 string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ C	1..1	code	There are no (further) constraints on this element Element id Consent.regulatoryBasis.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 (10241024) characters in size Data type* code 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: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ C	0..1	string	There are no (further) constraints on this element Element id Consent.regulatoryBasis.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 (10241024) characters in size Data type* string 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: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id Consent.regulatoryBasis.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 boolean 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	string	There are no (further) constraints on this element Element id Consent.regulatoryBasis.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 string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
policyBasis	S	0..1	BackboneElement	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 BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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..*	Extension	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 Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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	Reference(Resource)	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 Reference(Resource) 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	S	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	C	0..*	Reference(DocumentReference)	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 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(DocumentReference) 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	Σ	0..*	BackboneElement	There are no (further) constraints on this element 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 BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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..*	Extension	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 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 Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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	Σ	1..1	boolean	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 boolean 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	CodeableConcept	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 CodeableConcept Binding Types of Verification/Validation. ConsentVerificationCodes (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
verifiedBy	C	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 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(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	C	0..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 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(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)
verificationDate		0..*	dateTime	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 dateTime 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 Fixed to deny to use Consent as a Restriction Definition Action to take - permit or deny - as default. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* code Binding Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level. ConsentProvisionType (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value deny Mappings rim: n/a
provision	S Σ	0..1	BackboneElement	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 BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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..*	Extension	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 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 Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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	Period	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 Period 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..*	BackboneElement	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 BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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..*	Extension	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 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 Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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 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 CodeableConcept Binding How an actor is involved in the consent considerations. ParticipationRoleType (extensible) 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	C	0..1	Reference(CareTeam \| Device \| Group \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson)	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 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(CareTeam \| Device \| Group \| Organization \| Patient \| Practitioner \| PractitionerRole \| 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)
action	Σ	0..*	CodeableConcept	There are no (further) constraints on this element 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 CodeableConcept Binding Detailed codes for the consent action. ConsentActionCodes (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
securityLabel	Σ C	0..*	Coding	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 Coding Binding Example Security Labels from the Healthcare Privacy and Security Classification System. SecurityLabelExamples (example) 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	S Σ 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 Coding Binding What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. http://terminology.hl7.org/ValueSet/v3-PurposeOfUse (extensible) 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
id		0..1	string	There are no (further) constraints on this element Element id Consent.provision.purpose.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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Consent.provision.purpose.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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	uri	There are no (further) constraints on this element Element id Consent.provision.purpose.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 uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id Consent.provision.purpose.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 string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ C	1..1	code	There are no (further) constraints on this element Element id Consent.provision.purpose.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 (10241024) characters in size Data type* code 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: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ C	0..1	string	There are no (further) constraints on this element Element id Consent.provision.purpose.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 (10241024) characters in size Data type* string 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: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id Consent.provision.purpose.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 boolean 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 ]
documentType	S Σ C	0..*	CodingBinding	Element id Consent.provision.documentType Short description The category of data the provision concerns 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 Coding Binding The document type a consent provision covers. ndi-ehds-categories (required) 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
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 Coding Binding The resource types a consent provision covers. ResourceType (extensible) 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..*	CodeableConcept	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 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 CodeableConcept 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	Σ C	0..1	Period	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 Period 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"]
data	S Σ	0..*	BackboneElement	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 BackboneElement 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
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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..*	Extension	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 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 Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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 (10241024) characters in size Data type* code Binding How a resource reference is interpreted when testing consent restrictions. ConsentDataMeaning (required) 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	Reference(Resource)	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 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(Resource) 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..*	BackboneElement	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 BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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..*	Extension	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 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 Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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 (10241024) characters in size Data type* code Binding How a resource reference is interpreted when testing consent restrictions. ConsentDataMeaning (required) 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	Reference(OrganizationDataAccess)	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 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(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)
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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	string	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 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 string 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. 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 uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) 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	Identifier	Element id Consent.provision.data:fromCaregiverOrUnit.reference.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 Identifier 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
id		0..1	string	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 string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	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 May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension 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 code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) 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 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 CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) 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	uri	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 uri 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	string	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 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 string 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 123456 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	Period	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 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 Period 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	Reference(Organization)	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 Reference(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
display	Σ C	0..1	string	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 string 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	C	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	S	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	A record of a healthcare consumer’s choices or choices made on their behalf by a third party, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
Cardinality	0..*
Comments	Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment and consent for research participation and data sharing.
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()` ndi-consent-date-2: If present, date SHALL have a lower or equal value than period.start `date.hasValue().not() or date <= period.start` ndi-consent-actors-1: If any of category codes is "restriction", the person whose access is being restricted (grantee) cannot be the same person as the one whose data the restriction concerns (subject). `(subject.identifier != grantee.identifier) or category.coding.all(code != 'restriction')` ndi-consent-actors-2: If any of category codes is "restriction", the person whose access is being restricted (grantee) cannot be the same person as the one is creating the restriction (grantor). `(grantor.identifier != grantee.identifier) or category.coding.all(code != 'restriction')`
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
Type	id
Summary	True
Comments	Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
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
Type	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	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0..1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
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
Type	code
Binding	IETF language tag for a human language AllLanguages (required) Additional bindings CommonLanguages (starter)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
Consent.text		C
Short	Text summary of the resource, for human interpretation
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0..1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
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.contained		C
Short	Contained, inline Resources
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Cardinality	0..*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
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	May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.modifierExtension		Σ ?! C
Short	Extensions that cannot be ignored
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.identifier		Σ C
Short	Identifier for this record (external references)
Definition	Unique identifier for this copy of the Consent Statement.
Cardinality	0..*
Type	Identifier
Summary	True
Comments	This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.
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	active \| inactive
Definition	Indicates the current state of this Consent resource.
Cardinality	1..1
Type	code
Binding	Indicates the state of the consent. re-restriction-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	1..*
Type	CodeableConcept
Binding	A classification of the type of consents found in a consent statement. re-restriction-categories (required)
Must Support	True
Summary	True
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.
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
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
Type	Coding
Must Support	True
Summary	True
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.
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: CE.1-8, CE.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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
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
Type	uri
Must Support	True
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Consent.category.coding.version		Σ
Short	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.
Cardinality	0..1
Type	string
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.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
Type	code
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: CE.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
Type	string
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: CE.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
Type	boolean
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	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.
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
Type	string
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Consent.subject		S Σ C
Short	The patient whom the Restriction concerns
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	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.
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.subject.reference		S Σ C
Short	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.
Cardinality	0..1
Type	string
Must Support	True
Summary	True
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.
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. 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).
Cardinality	0..1
Type	uri
Binding	Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)
Summary	True
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.
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	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.
Cardinality	0..1
Type	Identifier
Must Support	True
Summary	True
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.
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.subject.identifier.use		Σ ?!
Short	usual \| official \| temp \| secondary \| old (If known)
Definition	The purpose of this identifier.
Cardinality	0..1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
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
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible)
Summary	True
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.
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
Type	uri
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
Type	string
Must Support	True
Summary	True
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.
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 123456
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
Type	Period
Summary	True
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.
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
Type	string
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 Σ C
Short	Date the restriction was created
Definition	The date when the grantor created the restriction. Can be before it was submitted to a server, e.g. by filling in a physical form
Cardinality	0..1
Type	date
Must Support	True
Summary	True
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ndi-consent-date-1: Date SHALL have a lower or equal value than today's date `$this <= today()`
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
Type	Period
Must Support	True
Summary	True
Alias	period
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.
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.period.start		S Σ C
Short	Starting time with inclusive boundary
Definition	The start of the period. The boundary is inclusive.
Cardinality	1..1
Type	dateTime
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-consent-period-start-1: Period.start SHALL have a higher or equal value than today's date `$this >= today()` 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	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.
Cardinality	0..1
Type	dateTime
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-consent-period-end-1: Period.end SHALL have a higher or equal value than today's date `$this >= today()` 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	The individual that created the Restriction
Definition	The entity responsible for granting the rights listed in a Consent Directive.
Cardinality	1..1
Type	Reference(PatientDataAccess \| PractitionerRole \| RelatedPerson)
Must Support	True
Summary	True
Alias	grantor
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.
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.grantor.reference		S Σ C
Short	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.
Cardinality	0..1
Type	string
Must Support	True
Summary	True
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.
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		S Σ
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. 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).
Cardinality	1..1
Type	uri
Binding	Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)
Must Support	True
Summary	True
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.
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	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.
Cardinality	0..1
Type	Identifier
Must Support	True
Summary	True
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.
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'` ndi-hsa-identifier-value-1: If identifier.system = urn:oid:1.2.752.29.4.19, value should follow format for HSA ID: SE1234567890-ABC1. Characters å, ä, ö, @ not valid. `value.matches('^SE[0-9]{10}-[A-za-z0-9]+$') or system != 'urn:oid:1.2.752.29.4.19'`
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.grantor.identifier.use		Σ ?!
Short	usual \| official \| temp \| secondary \| old (If known)
Definition	The purpose of this identifier.
Cardinality	0..1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
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
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible)
Summary	True
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.
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
Type	uri
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
Type	string
Must Support	True
Summary	True
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.
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 123456
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
Type	Period
Summary	True
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.
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
Type	string
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	The organization or individual whose access is being restricted
Definition	The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
Cardinality	0..*
Type	Reference(OrganizationDataAccess \| PatientDataAccess \| Practitioner \| RelatedPerson)
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.grantee.reference		S Σ C
Short	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.
Cardinality	0..1
Type	string
Must Support	True
Summary	True
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.
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		S Σ
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. 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).
Cardinality	1..1
Type	uri
Binding	Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)
Must Support	True
Summary	True
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.
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	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.
Cardinality	0..1
Type	Identifier
Must Support	True
Summary	True
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.
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'` 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-country-identifier-value-1: A country identifier should follow ISO-3166 format, e.g. SE `value.matches('^[A-Z]{2}$') or system != 'urn:iso:std:iso:3166'`
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.grantee.identifier.use		Σ ?!
Short	usual \| official \| temp \| secondary \| old (If known)
Definition	The purpose of this identifier.
Cardinality	0..1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
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
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible)
Summary	True
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.
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
Type	uri
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
Type	string
Must Support	True
Summary	True
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.
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 123456
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
Type	Period
Summary	True
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.
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
Type	string
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	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.
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	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.
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..*
Type	Attachment
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.
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		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	0..*
Type	Reference(Consent \| Contract \| DocumentReference \| QuestionnaireResponse)
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.
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.regulatoryBasis		S
Short	Regulations establishing base Consent
Definition	A set of codes that indicate the regulatory basis (if any) that this consent supports.
Cardinality	0..*
Type	CodeableConcept
Binding	Regulatory policy examples re-regulatory-bases-of-restriction (required)
Must Support	True
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.
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.regulatoryBasis.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
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Consent.regulatoryBasis.extension		C
Short	Additional content defined by implementations
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.regulatoryBasis.coding		S Σ C
Short	Code defined by a terminology system
Definition	A reference to a code defined by a terminology system.
Cardinality	1..1
Type	Coding
Must Support	True
Summary	True
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.
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: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Consent.regulatoryBasis.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
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Consent.regulatoryBasis.coding.extension		C
Short	Additional content defined by implementations
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.regulatoryBasis.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
Type	uri
Must Support	True
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Consent.regulatoryBasis.coding.version		Σ
Short	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.
Cardinality	0..1
Type	string
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Consent.regulatoryBasis.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
Type	code
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: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Consent.regulatoryBasis.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
Type	string
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: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Consent.regulatoryBasis.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
Type	boolean
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	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.
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.regulatoryBasis.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
Type	string
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Consent.policyBasis		S
Short	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.
Cardinality	0..1
Type	BackboneElement
Must Support	True
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.policyBasis.modifierExtension		Σ ?! C
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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		S
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
Type	url
Must Support	True
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	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.
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		Σ
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..*
Type	BackboneElement
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.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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.verification.modifierExtension		Σ ?! C
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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		Σ
Short	Has been verified
Definition	Has the instruction been verified.
Cardinality	1..1
Type	boolean
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
Short	Business case of verification
Definition	Extensible list of verification type starting with verification and re-validation.
Cardinality	0..1
Type	CodeableConcept
Binding	Types of Verification/Validation. ConsentVerificationCodes (example)
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.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	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.
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		C
Short	Person who verified
Definition	Who verified the instruction (Patient, Relative or other Authorized Person).
Cardinality	0..1
Type	Reference(Patient \| RelatedPerson)
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.
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.verificationDate
Short	When consent verified
Definition	Date(s) verification was collected.
Cardinality	0..*
Type	dateTime
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	Fixed to deny to use Consent as a Restriction
Definition	Action to take - permit or deny - as default.
Cardinality	1..1
Type	code
Binding	Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level. ConsentProvisionType (required)
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	deny
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	0..1
Type	BackboneElement
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.provision.modifierExtension		Σ ?! C
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Type	Period
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..*
Type	BackboneElement
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.provision.actor.modifierExtension		Σ ?! C
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Type	CodeableConcept
Binding	How an actor is involved in the consent considerations. ParticipationRoleType (extensible)
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.
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
Type	Reference(CareTeam \| Device \| Group \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson)
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.
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		Σ
Short	Actions controlled by this provision
Definition	Actions controlled by this provision.
Cardinality	0..*
Type	CodeableConcept
Binding	Detailed codes for the consent action. ConsentActionCodes (example)
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.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..*
Type	Coding
Binding	Example Security Labels from the Healthcare Privacy and Security Classification System. SecurityLabelExamples (example)
Summary	True
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.
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		S Σ 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..*
Type	Coding
Binding	What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. http://terminology.hl7.org/ValueSet/v3-PurposeOfUse (extensible)
Must Support	True
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.purpose.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
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Consent.provision.purpose.extension		C
Short	Additional content defined by implementations
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.provision.purpose.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
Type	uri
Must Support	True
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Consent.provision.purpose.version		Σ
Short	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.
Cardinality	0..1
Type	string
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Consent.provision.purpose.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
Type	code
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: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Consent.provision.purpose.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
Type	string
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: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Consent.provision.purpose.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
Type	boolean
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	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.
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.documentType		S Σ C
Short	The category of data the provision concerns
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..*
Type	Coding
Binding	The document type a consent provision covers. ndi-ehds-categories (required)
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.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..*
Type	Coding
Binding	The resource types a consent provision covers. ResourceType (extensible)
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..*
Type	CodeableConcept
Binding	If this code is found in an instance, then the exception applies. ConsentContentCodes (example)
Summary	True
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.
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		Σ 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
Type	Period
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.data		S Σ
Short	Data controlled by this provision
Definition	The resources controlled by this provision if specific resources are referenced.
Cardinality	0..*
Type	BackboneElement
Must Support	True
Summary	True
Meaning when missing	all data
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
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.provision.data.modifierExtension		Σ ?! C
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Type	code
Binding	How a resource reference is interpreted when testing consent restrictions. ConsentDataMeaning (required)
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	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.
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..*
Type	BackboneElement
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.provision.data:fromCaregiverOrUnit.modifierExtension		Σ ?! C
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Type	code
Binding	How a resource reference is interpreted when testing consent restrictions. ConsentDataMeaning (required)
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	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.
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.provision.data:fromCaregiverOrUnit.reference.reference		S Σ C
Short	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.
Cardinality	0..1
Type	string
Must Support	True
Summary	True
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.
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. 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).
Cardinality	0..1
Type	uri
Binding	Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)
Summary	True
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.
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	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.
Cardinality	0..1
Type	Identifier
Must Support	True
Summary	True
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.
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
Type	string
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	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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
Consent.provision.data:fromCaregiverOrUnit.reference.identifier.use		Σ ?!
Short	usual \| official \| temp \| secondary \| old (If known)
Definition	The purpose of this identifier.
Cardinality	0..1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
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
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible)
Summary	True
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.
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
Type	uri
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
Type	string
Must Support	True
Summary	True
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.
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 123456
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
Type	Period
Summary	True
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.
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
Type	string
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
Type	Expression
Comments	Constraining the expression type for a specific implementation via profile is recommended
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
Consent.provision.provision		S
Short	Nested Exception Provisions
Definition	Provisions which provide exceptions to the base provision or subprovisions.
Cardinality	0..*
Type	see (provision)
Must Support	True

<id value="restriction-re" />
<url value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
<version value="0.1.0" />
<name value="RestrictionRe" />
<title value="Restriction (RE)" />
<status value="active" />
<description value="Profile for restricting access to patient data" />
<fhirVersion value="5.0.0" />
<kind value="resource" />
<abstract value="false" />
<type value="Consent" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Consent" />
<derivation value="constraint" />
<differential>
<element id="Consent">
<path value="Consent" />
<constraint>
<key value="ndi-consent-date-2" />
<severity value="error" />
<human value="If present, date SHALL have a lower or equal value than period.start" />
<expression value="date.hasValue().not() or date <= period.start" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<constraint>
<key value="ndi-consent-actors-1" />
<severity value="error" />
<human value="If any of category codes is "restriction", the person whose access is being restricted (grantee) cannot be the same person as the one whose data the restriction concerns (subject)." />
<expression value="(subject.identifier != grantee.identifier) or category.coding.all(code != 'restriction')" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<constraint>
<key value="ndi-consent-actors-2" />
<severity value="error" />
<human value="If any of category codes is "restriction", the person whose access is being restricted (grantee) cannot be the same person as the one is creating the restriction (grantor)." />
<expression value="(grantor.identifier != grantee.identifier) or category.coding.all(code != 'restriction')" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
</element>
<element id="Consent.status">
<path value="Consent.status" />
<short value="active | inactive" />
<mustSupport value="true" />
<binding>
<strength value="required" />
<valueSet value="http://electronichealth.se/fhir/NDI/ValueSet/re-restriction-statuses" />
</binding>
</element>
<element id="Consent.category">
<path value="Consent.category" />
<min value="1" />
<mustSupport value="true" />
<binding>
<strength value="required" />
<valueSet value="http://electronichealth.se/fhir/NDI/ValueSet/re-restriction-categories" />
</binding>
</element>
<element id="Consent.category.coding">
<path value="Consent.category.coding" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.category.coding.system">
<path value="Consent.category.coding.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.category.coding.code">
<path value="Consent.category.coding.code" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.subject">
<path value="Consent.subject" />
<short value="The patient whom the Restriction concerns" />
<min value="1" />
<type>
<code value="Reference" />
<targetProfile value="http://electronichealth.se/fhir/NDI/StructureDefinition/patient-data-access" />
</type>
<mustSupport value="true" />
</element>
<element id="Consent.subject.reference">
<path value="Consent.subject.reference" />
<mustSupport value="true" />
</element>
<element id="Consent.subject.identifier">
<path value="Consent.subject.identifier" />
<constraint>
<key value="ndi-personal-identity-number-value-1" />
<severity value="error" />
<human value="A Swedish personal identity number (sv: personnummer) should follow format 198001032385" />
<expression value="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'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<constraint>
<key value="ndi-coordination-number-value-1" />
<severity value="error" />
<human value="A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399" />
<expression value="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'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<mustSupport value="true" />
</element>
<element id="Consent.subject.identifier.system">
<path value="Consent.subject.identifier.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.subject.identifier.value">
<path value="Consent.subject.identifier.value" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.date">
<path value="Consent.date" />
<short value="Date the restriction was created" />
<definition value="The date when the grantor created the restriction. Can be before it was submitted to a server, e.g. by filling in a physical form" />
<constraint>
<key value="ndi-consent-date-1" />
<severity value="error" />
<human value="Date SHALL have a lower or equal value than today's date" />
<expression value="$this <= today()" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<mustSupport value="true" />
</element>
<element id="Consent.period">
<path value="Consent.period" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.period.start">
<path value="Consent.period.start" />
<min value="1" />
<constraint>
<key value="ndi-consent-period-start-1" />
<severity value="error" />
<human value="Period.start SHALL have a higher or equal value than today's date" />
<expression value="$this >= today()" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<constraint>
<key value="ndi-dateTime-1" />
<severity value="error" />
<human value="DateTime must be without timestamp" />
<expression value="$this.toString().contains('T') = false" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<mustSupport value="true" />
</element>
<element id="Consent.period.end">
<path value="Consent.period.end" />
<constraint>
<key value="ndi-consent-period-end-1" />
<severity value="error" />
<human value="Period.end SHALL have a higher or equal value than today's date" />
<expression value="$this >= today()" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<constraint>
<key value="ndi-dateTime-1" />
<severity value="error" />
<human value="DateTime must be without timestamp" />
<expression value="$this.toString().contains('T') = false" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<mustSupport value="true" />
</element>
<element id="Consent.grantor">
<path value="Consent.grantor" />
<short value="The individual that created the Restriction" />
<min value="1" />
<max value="1" />
<type>
<code value="Reference" />
<targetProfile value="http://electronichealth.se/fhir/NDI/StructureDefinition/patient-data-access" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
</type>
<mustSupport value="true" />
</element>
<element id="Consent.grantor.reference">
<path value="Consent.grantor.reference" />
<mustSupport value="true" />
</element>
<element id="Consent.grantor.type">
<path value="Consent.grantor.type" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.grantor.identifier">
<path value="Consent.grantor.identifier" />
<constraint>
<key value="ndi-personal-identity-number-value-1" />
<severity value="error" />
<human value="A Swedish personal identity number (sv: personnummer) should follow format 198001032385" />
<expression value="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'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<constraint>
<key value="ndi-coordination-number-value-1" />
<severity value="error" />
<human value="A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399" />
<expression value="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'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<constraint>
<key value="ndi-hsa-identifier-value-1" />
<severity value="error" />
<human value="If identifier.system = urn:oid:1.2.752.29.4.19, value should follow format for HSA ID: SE1234567890-ABC1. Characters å, ä, ö, @ not valid." />
<expression value="value.matches('^SE[0-9]{10}-[A-za-z0-9]+$') or system != 'urn:oid:1.2.752.29.4.19'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<mustSupport value="true" />
</element>
<element id="Consent.grantor.identifier.system">
<path value="Consent.grantor.identifier.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.grantor.identifier.value">
<path value="Consent.grantor.identifier.value" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.grantee">
<path value="Consent.grantee" />
<short value="The organization or individual whose access is being restricted" />
<type>
<code value="Reference" />
<targetProfile value="http://electronichealth.se/fhir/NDI/StructureDefinition/organization-data-access" />
<targetProfile value="http://electronichealth.se/fhir/NDI/StructureDefinition/patient-data-access" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
</type>
<mustSupport value="true" />
</element>
<element id="Consent.grantee.reference">
<path value="Consent.grantee.reference" />
<mustSupport value="true" />
</element>
<element id="Consent.grantee.type">
<path value="Consent.grantee.type" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.grantee.identifier">
<path value="Consent.grantee.identifier" />
<constraint>
<key value="ndi-personal-identity-number-value-1" />
<severity value="error" />
<human value="A Swedish personal identity number (sv: personnummer) should follow format 198001032385" />
<expression value="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'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<constraint>
<key value="ndi-coordination-number-value-1" />
<severity value="error" />
<human value="A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399" />
<expression value="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'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<constraint>
<key value="ndi-organization-identifier-value-1" />
<severity value="error" />
<human value="A Swedish organization identifier (sv: organisationsnummer) should follow format 7999000057" />
<expression value="value.matches('^\\d{6}\\d{4}$') or system != 'urn:oid:2.5.4.97'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<constraint>
<key value="ndi-country-identifier-value-1" />
<severity value="error" />
<human value="A country identifier should follow ISO-3166 format, e.g. SE" />
<expression value="value.matches('^[A-Z]{2}$') or system != 'urn:iso:std:iso:3166'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<mustSupport value="true" />
</element>
<element id="Consent.grantee.identifier.system">
<path value="Consent.grantee.identifier.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.grantee.identifier.value">
<path value="Consent.grantee.identifier.value" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.regulatoryBasis">
<path value="Consent.regulatoryBasis" />
<mustSupport value="true" />
<binding>
<strength value="required" />
<valueSet value="http://electronichealth.se/fhir/NDI/ValueSet/re-regulatory-bases-of-restriction" />
</binding>
</element>
<element id="Consent.regulatoryBasis.coding">
<path value="Consent.regulatoryBasis.coding" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.regulatoryBasis.coding.system">
<path value="Consent.regulatoryBasis.coding.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.regulatoryBasis.coding.code">
<path value="Consent.regulatoryBasis.coding.code" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.policyBasis">
<path value="Consent.policyBasis" />
<mustSupport value="true" />
</element>
<element id="Consent.policyBasis.url">
<path value="Consent.policyBasis.url" />
<mustSupport value="true" />
</element>
<element id="Consent.decision">
<path value="Consent.decision" />
<short value="Fixed to deny to use Consent as a Restriction" />
<min value="1" />
<fixedCode value="deny" />
<mustSupport value="true" />
</element>
<element id="Consent.provision">
<path value="Consent.provision" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.provision.purpose">
<path value="Consent.provision.purpose" />
<mustSupport value="true" />
</element>
<element id="Consent.provision.purpose.system">
<path value="Consent.provision.purpose.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.provision.purpose.code">
<path value="Consent.provision.purpose.code" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.provision.documentType">
<path value="Consent.provision.documentType" />
<short value="The category of data the provision concerns" />
<mustSupport value="true" />
<binding>
<strength value="required" />
<valueSet value="http://electronichealth.se/fhir/NDI/ValueSet/ndi-ehds-categories" />
</binding>
</element>
<element id="Consent.provision.data">
<path value="Consent.provision.data" />
<slicing>
<discriminator>
<type value="value" />
<path value="meaning" />
</discriminator>
<description value="Slice data based on meaning" />
<ordered value="false" />
<rules value="open" />
</slicing>
<mustSupport value="true" />
</element>
<element id="Consent.provision.data.meaning">
<path value="Consent.provision.data.meaning" />
<mustSupport value="true" />
</element>
<element id="Consent.provision.data.reference">
<path value="Consent.provision.data.reference" />
<mustSupport value="true" />
</element>
<element id="Consent.provision.data:fromCaregiverOrUnit">
<path value="Consent.provision.data" />
<sliceName value="fromCaregiverOrUnit" />
<min value="0" />
<max value="*" />
<mustSupport value="true" />
</element>
<element id="Consent.provision.data:fromCaregiverOrUnit.meaning">
<path value="Consent.provision.data.meaning" />
<fixedCode value="authoredby" />
<mustSupport value="true" />
</element>
<element id="Consent.provision.data:fromCaregiverOrUnit.reference">
<path value="Consent.provision.data.reference" />
<type>
<code value="Reference" />
<targetProfile value="http://electronichealth.se/fhir/NDI/StructureDefinition/organization-data-access" />
</type>
<mustSupport value="true" />
</element>
<element id="Consent.provision.data:fromCaregiverOrUnit.reference.reference">
<path value="Consent.provision.data.reference.reference" />
<mustSupport value="true" />
</element>
<element id="Consent.provision.data:fromCaregiverOrUnit.reference.identifier">
<path value="Consent.provision.data.reference.identifier" />
<constraint>
<key value="ndi-organization-identifier-value-1" />
<severity value="error" />
<human value="A Swedish organization identifier (sv: organisationsnummer) should follow format 7999000057" />
<expression value="value.matches('^\\d{6}\\d{4}$') or system != 'urn:oid:2.5.4.97'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<constraint>
<key value="ndi-personal-identity-number-value-1" />
<severity value="error" />
<human value="A Swedish personal identity number (sv: personnummer) should follow format 198001032385" />
<expression value="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'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<constraint>
<key value="ndi-coordination-number-value-1" />
<severity value="error" />
<human value="A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399" />
<expression value="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'" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" />
</constraint>
<mustSupport value="true" />
</element>
<element id="Consent.provision.data:fromCaregiverOrUnit.reference.identifier.system">
<path value="Consent.provision.data.reference.identifier.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.provision.data:fromCaregiverOrUnit.reference.identifier.value">
<path value="Consent.provision.data.reference.identifier.value" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Consent.provision.provision">
<path value="Consent.provision.provision" />
<mustSupport value="true" />
</element>
</differential>

</StructureDefinition>

{

"resourceType": "StructureDefinition",
"id": "restriction-re",
"url": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re",
"version": "0.1.0",
"name": "RestrictionRe",
"title": "Restriction (RE)",
"status": "active",
"description": "Profile for restricting access to patient data",
"fhirVersion": "5.0.0",
"kind": "resource",
"abstract": false,
"type": "Consent",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Consent",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Consent",
"path": "Consent",
"constraint": [
{
"key": "ndi-consent-date-2",
"severity": "error",
"human": "If present, date SHALL have a lower or equal value than period.start",
"expression": "date.hasValue().not() or date <= period.start",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
},
{
"key": "ndi-consent-actors-1",
"severity": "error",
"human": "If any of category codes is \"restriction\", the person whose access is being restricted (grantee) cannot be the same person as the one whose data the restriction concerns (subject).",
"expression": "(subject.identifier != grantee.identifier) or category.coding.all(code != 'restriction')",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
},
{
"key": "ndi-consent-actors-2",
"severity": "error",
"human": "If any of category codes is \"restriction\", the person whose access is being restricted (grantee) cannot be the same person as the one is creating the restriction (grantor).",
"expression": "(grantor.identifier != grantee.identifier) or category.coding.all(code != 'restriction')",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
}
]
},
{
"id": "Consent.status",
"path": "Consent.status",
"short": "active | inactive",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/fhir/NDI/ValueSet/re-restriction-statuses"
}
},
{
"id": "Consent.category",
"path": "Consent.category",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/fhir/NDI/ValueSet/re-restriction-categories"
}
},
{
"id": "Consent.category.coding",
"path": "Consent.category.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Consent.category.coding.system",
"path": "Consent.category.coding.system",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.category.coding.code",
"path": "Consent.category.coding.code",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.subject",
"path": "Consent.subject",
"short": "The patient whom the Restriction concerns",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": [
"http://electronichealth.se/fhir/NDI/StructureDefinition/patient-data-access"
]
}
],
"mustSupport": true
},
{
"id": "Consent.subject.reference",
"path": "Consent.subject.reference",
"mustSupport": true
},
{
"id": "Consent.subject.identifier",
"path": "Consent.subject.identifier",
"constraint": [
{
"key": "ndi-personal-identity-number-value-1",
"severity": "error",
"human": "A Swedish personal identity number (sv: personnummer) should follow format 198001032385",
"expression": "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'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
},
{
"key": "ndi-coordination-number-value-1",
"severity": "error",
"human": "A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399",
"expression": "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'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
}
],
"mustSupport": true
},
{
"id": "Consent.subject.identifier.system",
"path": "Consent.subject.identifier.system",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.subject.identifier.value",
"path": "Consent.subject.identifier.value",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.date",
"path": "Consent.date",
"short": "Date the restriction was created",
"definition": "The date when the grantor created the restriction. Can be before it was submitted to a server, e.g. by filling in a physical form",
"constraint": [
{
"key": "ndi-consent-date-1",
"severity": "error",
"human": "Date SHALL have a lower or equal value than today's date",
"expression": "$this <= today()",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
}
],
"mustSupport": true
},
{
"id": "Consent.period",
"path": "Consent.period",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.period.start",
"path": "Consent.period.start",
"min": 1,
"constraint": [
{
"key": "ndi-consent-period-start-1",
"severity": "error",
"human": "Period.start SHALL have a higher or equal value than today's date",
"expression": "$this >= today()",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
},
{
"key": "ndi-dateTime-1",
"severity": "error",
"human": "DateTime must be without timestamp",
"expression": "$this.toString().contains('T') = false",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
}
],
"mustSupport": true
},
{
"id": "Consent.period.end",
"path": "Consent.period.end",
"constraint": [
{
"key": "ndi-consent-period-end-1",
"severity": "error",
"human": "Period.end SHALL have a higher or equal value than today's date",
"expression": "$this >= today()",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
},
{
"key": "ndi-dateTime-1",
"severity": "error",
"human": "DateTime must be without timestamp",
"expression": "$this.toString().contains('T') = false",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
}
],
"mustSupport": true
},
{
"id": "Consent.grantor",
"path": "Consent.grantor",
"short": "The individual that created the Restriction",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://electronichealth.se/fhir/NDI/StructureDefinition/patient-data-access",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
],
"mustSupport": true
},
{
"id": "Consent.grantor.reference",
"path": "Consent.grantor.reference",
"mustSupport": true
},
{
"id": "Consent.grantor.type",
"path": "Consent.grantor.type",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.grantor.identifier",
"path": "Consent.grantor.identifier",
"constraint": [
{
"key": "ndi-personal-identity-number-value-1",
"severity": "error",
"human": "A Swedish personal identity number (sv: personnummer) should follow format 198001032385",
"expression": "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'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
},
{
"key": "ndi-coordination-number-value-1",
"severity": "error",
"human": "A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399",
"expression": "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'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
},
{
"key": "ndi-hsa-identifier-value-1",
"severity": "error",
"human": "If identifier.system = urn:oid:1.2.752.29.4.19, value should follow format for HSA ID: SE1234567890-ABC1. Characters å, ä, ö, @ not valid.",
"expression": "value.matches('^SE[0-9]{10}-[A-za-z0-9]+$') or system != 'urn:oid:1.2.752.29.4.19'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
}
],
"mustSupport": true
},
{
"id": "Consent.grantor.identifier.system",
"path": "Consent.grantor.identifier.system",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.grantor.identifier.value",
"path": "Consent.grantor.identifier.value",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.grantee",
"path": "Consent.grantee",
"short": "The organization or individual whose access is being restricted",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://electronichealth.se/fhir/NDI/StructureDefinition/organization-data-access",
"http://electronichealth.se/fhir/NDI/StructureDefinition/patient-data-access",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
],
"mustSupport": true
},
{
"id": "Consent.grantee.reference",
"path": "Consent.grantee.reference",
"mustSupport": true
},
{
"id": "Consent.grantee.type",
"path": "Consent.grantee.type",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.grantee.identifier",
"path": "Consent.grantee.identifier",
"constraint": [
{
"key": "ndi-personal-identity-number-value-1",
"severity": "error",
"human": "A Swedish personal identity number (sv: personnummer) should follow format 198001032385",
"expression": "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'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
},
{
"key": "ndi-coordination-number-value-1",
"severity": "error",
"human": "A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399",
"expression": "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'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
},
{
"key": "ndi-organization-identifier-value-1",
"severity": "error",
"human": "A Swedish organization identifier (sv: organisationsnummer) should follow format 7999000057",
"expression": "value.matches('^\\\\d{6}\\\\d{4}$') or system != 'urn:oid:2.5.4.97'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
},
{
"key": "ndi-country-identifier-value-1",
"severity": "error",
"human": "A country identifier should follow ISO-3166 format, e.g. SE",
"expression": "value.matches('^[A-Z]{2}$') or system != 'urn:iso:std:iso:3166'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
}
],
"mustSupport": true
},
{
"id": "Consent.grantee.identifier.system",
"path": "Consent.grantee.identifier.system",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.grantee.identifier.value",
"path": "Consent.grantee.identifier.value",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.regulatoryBasis",
"path": "Consent.regulatoryBasis",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/fhir/NDI/ValueSet/re-regulatory-bases-of-restriction"
}
},
{
"id": "Consent.regulatoryBasis.coding",
"path": "Consent.regulatoryBasis.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Consent.regulatoryBasis.coding.system",
"path": "Consent.regulatoryBasis.coding.system",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.regulatoryBasis.coding.code",
"path": "Consent.regulatoryBasis.coding.code",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.policyBasis",
"path": "Consent.policyBasis",
"mustSupport": true
},
{
"id": "Consent.policyBasis.url",
"path": "Consent.policyBasis.url",
"mustSupport": true
},
{
"id": "Consent.decision",
"path": "Consent.decision",
"short": "Fixed to deny to use Consent as a Restriction",
"min": 1,
"fixedCode": "deny",
"mustSupport": true
},
{
"id": "Consent.provision",
"path": "Consent.provision",
"max": "1",
"mustSupport": true
},
{
"id": "Consent.provision.purpose",
"path": "Consent.provision.purpose",
"mustSupport": true
},
{
"id": "Consent.provision.purpose.system",
"path": "Consent.provision.purpose.system",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.provision.purpose.code",
"path": "Consent.provision.purpose.code",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.provision.documentType",
"path": "Consent.provision.documentType",
"short": "The category of data the provision concerns",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/fhir/NDI/ValueSet/ndi-ehds-categories"
}
},
{
"id": "Consent.provision.data",
"path": "Consent.provision.data",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "meaning"
}
],
"description": "Slice data based on meaning",
"ordered": false,
"rules": "open"
},
"mustSupport": true
},
{
"id": "Consent.provision.data.meaning",
"path": "Consent.provision.data.meaning",
"mustSupport": true
},
{
"id": "Consent.provision.data.reference",
"path": "Consent.provision.data.reference",
"mustSupport": true
},
{
"id": "Consent.provision.data:fromCaregiverOrUnit",
"path": "Consent.provision.data",
"sliceName": "fromCaregiverOrUnit",
"min": 0,
"max": "*",
"mustSupport": true
},
{
"id": "Consent.provision.data:fromCaregiverOrUnit.meaning",
"path": "Consent.provision.data.meaning",
"fixedCode": "authoredby",
"mustSupport": true
},
{
"id": "Consent.provision.data:fromCaregiverOrUnit.reference",
"path": "Consent.provision.data.reference",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://electronichealth.se/fhir/NDI/StructureDefinition/organization-data-access"
]
}
],
"mustSupport": true
},
{
"id": "Consent.provision.data:fromCaregiverOrUnit.reference.reference",
"path": "Consent.provision.data.reference.reference",
"mustSupport": true
},
{
"id": "Consent.provision.data:fromCaregiverOrUnit.reference.identifier",
"path": "Consent.provision.data.reference.identifier",
"constraint": [
{
"key": "ndi-organization-identifier-value-1",
"severity": "error",
"human": "A Swedish organization identifier (sv: organisationsnummer) should follow format 7999000057",
"expression": "value.matches('^\\\\d{6}\\\\d{4}$') or system != 'urn:oid:2.5.4.97'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
},
{
"key": "ndi-personal-identity-number-value-1",
"severity": "error",
"human": "A Swedish personal identity number (sv: personnummer) should follow format 198001032385",
"expression": "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'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
},
{
"key": "ndi-coordination-number-value-1",
"severity": "error",
"human": "A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399",
"expression": "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'",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re"
}
],
"mustSupport": true
},
{
"id": "Consent.provision.data:fromCaregiverOrUnit.reference.identifier.system",
"path": "Consent.provision.data.reference.identifier.system",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.provision.data:fromCaregiverOrUnit.reference.identifier.value",
"path": "Consent.provision.data.reference.identifier.value",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.provision.provision",
"path": "Consent.provision.provision",
"mustSupport": true
}
]
}

}

Details

The red must-support flag ("S") indicates that the element is expected in some use cases, and a missing flag that the element is never used.

For whom - To whose data is access being restricted

To define the patient in question whose data the restriction is restricting access to, use the subject element. To reference the patient using an existing external identifier, the system of the identifier and the value should be provided. The system ID declares what type of identifier the patient identifier is.

{
  [...]
  "subject": {
    "identifier": {
      "system": "http://electronichealth.se/identifier/personnummer",
      "value": "198001032385"
    }
  }
}

Current valid patient identifiers are:

Personal identity number (sv: personnummer)
- system: http://electronichealth.se/identifier/personnummer
- value format: 12 digits without hyphen, e.g. 198001032385
Coordination number (sv: samordningsnummer)
- system: http://electronichealth.se/identifier/samordningsnummer
- value format: 12 digits without hyphen, e.g. 201903682399

By whom - Who created the restriction

To define who created the restriction, use the grantor element. Valid grantors are the patient itself, a healthcare professional on duty at a care provider and an authorized person related to the patient.

If a valid external identifier exists for the grantor, it can be used in the reference. To reference the grantor's existing external identifier, the system of the identifier and the value should be provided. The system ID declares what type of identifier the external identifier is.

{
  [...]
  "grantor": {
    "identifier": {
      "system": "http://electronichealth.se/identifier/personnummer",
      "value": "198001032385"
    },
    "type": "RelatedPerson"
  }
}

The type element declares what role the grantor has.

If the grantor is of type Patient or RelatedPerson, current valid identifiers are:

Personal identity number (sv: personnummer)
- system: http://electronichealth.se/identifier/personnummer
- value format: 12 digits without hyphen, e.g. 198001032385
Coordination number (sv: samordningsnummer)
- system: http://electronichealth.se/identifier/samordningsnummer
- value format: 12 digits without hyphen, e.g. 201903682399

Healthcare professional

If the grantor is a healthcare professional, i.e. of type PractitionerRole, current valid identifiers are:

HSA ID
- system: urn:oid:1.2.752.29.4.19
- value format: SE+10 digits+hyphen+a number of alphanumerical characters, e.g. SE1234567890-ABC1

Against whom - Whose access is being restricted

To define whose access is being restricted, the element grantee should be used. Valid grantees are a country, a healthcare provider, a healthcare unit, a patient, a healthcare practitioner and a person related to the patient.

Note that a healthcare practitioner as a grantee implies that the practitioner's access will be restricted on all of its workplaces, as the restriction will be tied to the individual and not its role at a specific care provider.

A related person to the patient as a grantee can be identified by its relationship to the patient or by its personal identifier. To define a related person by its relationship to the patient, the grantee reference should be a relative reference to an instance of RelatedPerson with the element RelatedPerson.relationship filled in with the relationship type code.

To use an external identifier to reference to the grantee, it should be supplied in the identifier element. To reference the grantee's existing external identifier, the system of the identifier and the value should be provided. The system ID declares what type of identifier the external identifier is.

{
  [...]
  "grantee": {
    "identifier": {
      "system": "http://electronichealth.se/identifier/personnummer",
      "value": "198001032385"
    },
    "type": "Organization"
  }
}

If the grantee is of type Patient or RelatedPerson, current valid identifiers are:

Personal identity number (sv: personnummer)
- system: http://electronichealth.se/identifier/personnummer
- value format: 12 digits without hyphen, e.g. 198001032385
Coordination number (sv: samordningsnummer)
- system: http://electronichealth.se/identifier/samordningsnummer
- value format: 12 digits without hyphen, e.g. 201903682399

Healthcare practitioner

If the grantee is a healthcare practitioner, i.e. of type Practitioner, current valid identifiers are:

Personal identity number (sv: personnummer)
- system: http://electronichealth.se/identifier/personnummer
- value format: 12 digits without hyphen, e.g. 198001032385
Coordination number (sv: samordningsnummer)
- system: http://electronichealth.se/identifier/samordningsnummer
- value format: 12 digits without hyphen, e.g. 201903682399

Country

If the grantee is a country, i.e. of type Organization, current valid identifiers are:

Country code according to ISO-3166
- system: urn:iso:std:iso:3166
- value format: 2 characters, e.g. SE

Healthcare provider

If the grantee is a healthcare provider, i.e. of type Organization, current valid identifiers are:

Organization identifier (sv: organisationsnummer)
- system: urn:oid:2.5.4.97
- value format: 10 digits without hyphen, e.g. 2021005389
Personal identity number (sv: personnummer)
- system: http://electronichealth.se/identifier/personnummer
- value format: 12 digits without hyphen, e.g. 198001032385
Coordination number (sv: samordningsnummer)
- system: http://electronichealth.se/identifier/samordningsnummer
- value format: 12 digits without hyphen, e.g. 201903682399

Healthcare unit

If the grantee is a healthcare unit, i.e. of type Organization, current valid identifiers are:

HSA ID
- system: urn:oid:1.2.752.29.4.19
- value format: SE+10 digits+hyphen+a number of alphanumerical characters, e.g. SE1234567890-ABC1

When - During what time frame is access being restricted

To define when the restriction is valid, use the period element. Note that a start time for the restriction has to be supplied. If an end time is not supplied, the restriction should be interpreted as indefinite.

{
  [...]
  "period": {
    "start": "2026-11-12",
    "end": "2027-11-12"
  }
}

What - To what data is access being restricted

The default state of a restriction is that all patient data is being restricted. The provision element describes an exception to the restriction. The provision element can in turn contain a nested provision element that describes an exception to the exception. A Consent with decision set to deny and that contains a provision can be read as "Restrict everything except for X". If the provision contains a provision it can be read as "Restrict everything except for X, with the exception of Y".

If the first provision is empty it can be read as "Restrict everything except for everything". If the provision contains a provision it can be read as "Restrict everything except for everything, with the exception of Y". This means that the nested provision can be used to specify what data should be restricted, as Y.

The data can be defined in the provision element in a few different ways, which are explained in the following sections.

Define data by its source

To define a restriction that restricts access to data from a certain source the provision.data element should be used. A data source can be a care giver, care unit or country. The data element contains a reference that can reference to the source as a Organization. The data element also contains a meaning element that should be set to "authoredby" to specify that the reference is a data source.

If a data source is not supplied, the data definition should be interpreted to regard data from any data source and that matches the other data filters.

{
  [...]
  "provision": [ 
    {
      "data": [
        {
          "reference": {
            "identifier": { 
              "system": "urn:oid:2.5.4.97",
              "value": "2021005389"
            }
          },
          "meaning": "authoredby"
        }
      ]
    }
  ]
}

Country

If the data source is a country, current valid identifiers are:

Country code according to ISO-3166
- system: urn:iso:std:iso:3166
- value format: 2 characters, e.g. SE

Healthcare provider

If the data source is a healthcare provider, current valid identifiers are:

Organization identifier (sv: organisationsnummer)
- system: urn:oid:2.5.4.97
- value format: 10 digits without hyphen, e.g. 2021005389
Personal identity number (sv: personnummer)
- system: http://electronichealth.se/identifier/personnummer
- value format: 12 digits without hyphen, e.g. 198001032385
Coordination number (sv: samordningsnummer)
- system: http://electronichealth.se/identifier/samordningsnummer
- value format: 12 digits without hyphen, e.g. 201903682399

Healthcare unit

If the data source is a healthcare unit, current valid identifiers are:

HSA ID
- system: urn:oid:1.2.752.29.4.19
- value format: SE+10 digits+hyphen+a number of alphanumerical characters, e.g. SE1234567890-ABC1

Define data by information category

To define a restriction that restricts access to a data of a certain information category the provision.documentType element should be used. Use codes from value set Datakategorier enligt EHDS.

If an information category is not supplied, the data definition should be interpreted to regard data of all information categories and that matches the other data filters.

{
  [...]
  "provision": [ 
    {
      "documentType": [
        {
          "system": "<code system>",
          "code": "<information category code>"
        }
      ]
    }
  ]
}

Reference to instance of data

To define a restriction that restricts access to a specific piece of data the provision.data element should be used. The data element contains a reference that can reference to an instance of for example an observation or a diagnosis. The meaning should be set to instance to specify that the reference is a data instance.

If a reference to an instance is not supplied, the data definition should be interpreted to regard all data that matches the other data filters.

{
  [...]
  "provision": [ 
    {
      "data": [
        {
          "reference": {
            "reference": "Observation/02d9860a-18a8-43a2-a961-04219650e72c"
          },
          "meaning": "instance"
        }
      ]
    }
  ]
}

ValueSet bindings

The following table shows the elements in the profile that should be populated with codes as well as what value sets contain the valid codes for the respective elements. The strength indicates whether it is recommended or required to choose a code from the defined value set.

Path	Strength	ValueSet
Consent.status	required	http://electronichealth.se/fhir/NDI/ValueSet/re-restriction-statuses
Consent.category	required	http://electronichealth.se/fhir/NDI/ValueSet/re-restriction-categories
Consent.regulatoryBasis	required	http://electronichealth.se/fhir/NDI/ValueSet/re-regulatory-bases-of-restriction
Consent.provision.documentType	required	http://electronichealth.se/fhir/NDI/ValueSet/ndi-ehds-categories

Validation rules

This section contains validation rules of a Restriction along with corresponding error messages. The error messages are returned in an OperationOutcome. An OperationOutcome contains an array of issues where each issue has a details element containing an error message and when relevant an expression element containing the path to the element which the error pertains to.

General

This section contains error messages when violating general conformance rules defined in the profile, such as cardinality.

Description	Error message	Severity
Cardinality of elements must be followed	2-XX-5: Attribut har kardinalitet %s men har angivits %s gånger	Error
Code must be from required value set	2-XX-6: Ogiltig kod	Error
Identifier systems must be be from list of valid systems (see Details section above)	2-XX-4: Ogiltigt system-ID	Error

Invariants

Invariants express additional constraints in the profile which cannot be expressed using cardinality, data types and terminology bindings. These rules can pertain to for example valid value formats based on certain conditions and valid combinations of elements.

Rule ID	Element	Description	Error message	Severity	Expression
ndi-consent-date-1	Consent.date	Date SHALL have a lower or equal value than today's date	2-XX-12: Författningsdatum får inte vara ett framtida datum.	Error	`$this <= today()`
ndi-organization-identifier-value-1	Consent.grantee.identifier, Consent.provision.data.reference.identifier	Swedish organization identifier (sv: organisationsnummer) should follow format 7999000057	2-XX-7: Ogiltigt format på organisationsnummer. Ange tiosiffriga organisationsnumret utan bindestreck, t. ex. 9966353346	Error	`value.matches('^\\d{6}\\d{4}$') or system != 'urn:oid:2.5.4.97'`
ndi-country-identifier-value-1	Consent.provision.data.reference.identifier	A country identifier should follow ISO-3166 format, e.g. SE		Error	`value.matches('^[A-Z]{2}$') or system != 'urn:iso:std:iso:3166'`
per-1	Consent.period	If present, start SHALL have a lower or equal value than end	2-XX-15: Slutdatum måste vara samtidigt som eller senare än startdatum.	Error	`start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())`
ndi-consent-period-end-1	Consent.period.end	Period.end SHALL have a higher or equal value than today's date	2-XX-14: Start- och slutdatum får inte vara passerade datum.	Error	`$this >= today()`
ndi-consent-period-start-1	Consent.period.start	Period.start SHALL have a higher or equal value than today's date	2-XX-14: Start- och slutdatum får inte vara passerade datum.	Error	`$this >= today()`
ndi-dateTime-1	Consent.period.start, Consent.period.end	DateTime must be a valid date that follows format YYYY-MM-DD without timestamp	2-XX-17: Datum ska vara ett giltigt datum som anges på formatet YYYY-MM-DD utan tidsangivelse	Error	`$this.matches('^\\d{4}-\\d{2}-\\d{2}$')`
ndi-personal-identity-number-value-1	Consent.subject.identifier, Consent.grantor.identifier, Consent.grantee.identifier	A Swedish personal identity number (sv: personnummer) should follow format 198001032385	2-XX-2: Ogiltigt format på personnummer. Ange tolvsiffriga personnumret utan bindestreck, t. ex. 198001032385	Error	`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	Consent.subject.identifier, Consent.grantor.identifier, Consent.grantee.identifier, Consent.provision.data.reference.identifier	A Swedish coordination number (sv: samordningsnummer) should follow format 201903682399	2-XX-3: Ogiltigt format på samordningsnummer. Ange tolvsiffriga samordningsnumret utan bindestreck, t. ex. 198000602394	Error	`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'`
ndi-hsa-identifier-value-1	Consent.grantor.identifier	A HSA ID should follow format SE1234567890-ABC1	2-XX-18: Ogiltigt format på HSA ID. Ange ID:et i format "SE<10 siffror>-<suffix>", tex SE1234567890-ABC1.	Error	`value.matches('^SE[0-9]{10}-[A-za-z0-9]+$') or system != 'urn:oid:1.2.752.29.4.19'`
ndi-consent-actors-1	Consent.grantee, Consent.subject	If any of category codes is "restriction", the person whose access is being restricted (grantee) cannot be the same person as the one whose data the restriction concerns (subject).	2-XX-19: Spärr får inte vara mot den person vars personuppgifter spärren berör.	Error	`(subject.identifier != grantee.identifier) or category.coding.all(code != 'restriction')`
ndi-consent-actors-2	Consent.grantee, Consent.grantor	If any of category codes is "restriction", the person whose access is being restricted (grantee) cannot be the same person as the one is creating the restriction (grantor).	2-XX-20: Spärr får inte vara mot den person som skapar spärren.	Error	`(grantor.identifier != grantee.identifier) or category.coding.all(code != 'restriction')`

Business rules

Examples

This section contains example instances of Restrictions to illustrate how the profile can be used to express restrictions for different use cases. See section Supported operations for information on how to query and create/update Restrictions.

Note that all logical IDs and personal identifiers are fictional and can not be queried.

Opt out

The following example shows how to use Restriction to express a Patient choosing to opt out of sharing all patient data. This is done by setting the regulatoryBasis coding to the EHDS Article 10 and the decision to deny. The subject references the Patient in question, who is also referenced to as the grantor - i.e. the individual that decides to restrict access. These references reference the patient's personal identity number, using the system ID "http://electronichealth.se/identifier/personnummer". The category coding is set to restriction for indexing purposes.

Overview
JSON

Consent

id : 39565af2-9ea6-4504-a1f0-857380ddfedd

status : active

category

coding

system : http://electronichealth.se/CodeSystem/consent-category

code : restriction-optout

category

coding

system : http://electronichealth.se/CodeSystem/consent-category

code : restriction

subject

identifier

system : http://electronichealth.se/identifier/personnummer

value : 198001022386

date : 2025-10-07

period

start : 2025-10-07

grantor

type : Patient

identifier

system : http://electronichealth.se/identifier/personnummer

value : 198001022386

regulatoryBasis

coding

system : https://eur-lex.europa.eu/eli/reg/2025/327/oj

code : Article10

decision : deny

{

"resourceType": "Consent",

"id": "39565af2-9ea6-4504-a1f0-857380ddfedd",

"status": "active",

"category": [

{

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/consent-category",

"code": "restriction-optout"

}

]

{

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/consent-category",

"code": "restriction"

}

]

}

"subject": {

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "198001022386"

}

"date": "2025-10-07",

"period": {

"start": "2025-10-07"

"grantor": [

{

"type": "Patient",

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "198001022386"

}

"regulatoryBasis": [

{

"coding": [

{

"system": "https://eur-lex.europa.eu/eli/reg/2025/327/oj",

"code": "Article10"

}

]

}

"decision": "deny"

}

Restrict access of legal guardians using role

The following example shows how to construct a Restriction where a Patient restricts any and all of its legal guardians to access all patient data.

Restriction

The following example shows how to use Restriction to express a patient choosing to restrict its legal guardians, by referencing the role of legal guardian, from accessing all of its patient data. This is done by setting the decision to deny and referencing to a RelatedPerson as grantee - i.e. who is affected by the content of the Restriction. See the example of RelatedPerson as a legal guardian below. The subject references the Patient in question, who is also referenced to as the grantor - i.e. the individual that decides to restrict access. These references reference the patient's personal identity number, using the system ID "http://electronichealth.se/identifier/personnummer". The category coding is set to restriction for indexing purposes.

Overview
JSON

Consent

id : 9BDDA36F-DB9E-4847-B451-635DA047D104

status : active

category

coding

system : http://electronichealth.se/CodeSystem/consent-category

code : restriction

subject

identifier

system : http://electronichealth.se/identifier/personnummer

value : 200001032390

date : 2025-10-07

period

start : 2025-10-07

grantor

type : Patient

identifier

system : http://electronichealth.se/identifier/personnummer

value : 200001032390

grantee

reference : urn:uuid:8E61CF5B-2945-426C-8DFC-CAB78CB0AD3A

type : RelatedPerson

decision : deny

{

"resourceType": "Consent",

"id": "9BDDA36F-DB9E-4847-B451-635DA047D104",

"status": "active",

"category": [

{

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/consent-category",

"code": "restriction"

}

]

}

"subject": {

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "200001032390"

}

"date": "2025-10-07",

"period": {

"start": "2025-10-07"

"grantor": [

{

"type": "Patient",

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "200001032390"

}

"grantee": [

{

"reference": "urn:uuid:8E61CF5B-2945-426C-8DFC-CAB78CB0AD3A",

"type": "RelatedPerson"

}

"decision": "deny"

}

Legal guardian

The following example shows a RelatedPerson as any and all legal guardians of the patient. This example covers all the patients legal guardians by setting the relationship coding to guardian. This is instead of pointing to specific individuals using identifiers, which guarantees that the restriction still stands even if a patient changes legal guardians for example. According to the base resource it must be explicitly declared what patient the related person is related to, which is done in the patient element that references to the Patient that is the subject of the Restriction.

Overview
JSON

RelatedPerson

id : 8E61CF5B-2945-426C-8DFC-CAB78CB0AD3A

patient

identifier

system : http://electronichealth.se/identifier/personnummer

value : 200001032390

relationship

coding

system : http://terminology.hl7.org/CodeSystem/v3-RoleClass

code : GUARD

{

"resourceType": "RelatedPerson",

"id": "8E61CF5B-2945-426C-8DFC-CAB78CB0AD3A",

"patient": {

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "200001032390"

}

"relationship": [

{

"coding": [

{

"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",

"code": "GUARD"

}

]

}

]

}

The following example shows how to use Restriction to express a patient choosing to restrict a related person or a practitioner, by referencing the person's personal identifier, from accessing all of its patient data. This is done by setting the decision to deny and referencing to the personal identity number a related person or practitioner as grantee - i.e. who is affected by the content of the Restriction. The grantee.type element should be set to RelatedPerson or Practitioner. The subject references the Patient in question, who is also referenced to as the grantor - i.e. the individual that decides to restrict access. These references reference the patient's personal identity number, using the system ID "http://electronichealth.se/identifier/personnummer". The category coding is set to restriction for indexing purposes.

Overview
JSON

Consent

id : 5ad8e480-b58c-4a9c-9d45-256bed7cbc98

status : active

category

coding

system : http://electronichealth.se/CodeSystem/consent-category

code : restriction

subject

identifier

system : http://electronichealth.se/identifier/personnummer

value : 200001032390

date : 2025-10-07

period

start : 2025-10-07

grantor

type : Patient

identifier

system : http://electronichealth.se/identifier/personnummer

value : 200001032390

grantee

type : RelatedPerson

identifier

system : http://electronichealth.se/identifier/personnummer

value : 198001022386

decision : deny

{

"resourceType": "Consent",

"id": "5ad8e480-b58c-4a9c-9d45-256bed7cbc98",

"status": "active",

"category": [

{

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/consent-category",

"code": "restriction"

}

]

}

"subject": {

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "200001032390"

}

"date": "2025-10-07",

"period": {

"start": "2025-10-07"

"grantor": [

{

"type": "Patient",

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "200001032390"

}

"grantee": [

{

"type": "RelatedPerson",

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "198001022386"

}

"decision": "deny"

}

Restrict access of all EU countries but Sweden

The following example shows how to construct a Restriction where a Patient restricts all EU countries but Sweden to have access to its patient data. This is done by setting the decision to deny, which by default blocks all EU countries from accessing the data. To declare that the country of Sweden is an exception to this restriction, the provision.actor element is used to reference the country as a Organization with an identifier containing the country code. The subject references the Patient in question, who is also referenced to as the grantor - i.e. the individual that decides to restrict access. These references reference the patient's personal identity number, using the system ID "http://electronichealth.se/identifier/personnummer". The category coding is set to restriction for indexing purposes.

Overview
JSON

Consent

id : 7c4fb55e-2d4c-48cd-b32c-190e84cfee22

status : active

category

coding

system : http://electronichealth.se/CodeSystem/consent-category

code : restriction

subject

identifier

system : http://electronichealth.se/identifier/personnummer

value : 198001022386

date : 2025-10-07

period

start : 2025-10-07

grantor

type : Patient

identifier

system : http://electronichealth.se/identifier/personnummer

value : 198001022386

regulatoryBasis

coding

system : https://eur-lex.europa.eu/eli/reg/2025/327/oj

code : Article10

decision : deny

provision

actor

reference

identifier

system : urn:iso:std:iso:3166

value : SE

{

"resourceType": "Consent",

"id": "7c4fb55e-2d4c-48cd-b32c-190e84cfee22",

"status": "active",

"category": [

{

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/consent-category",

"code": "restriction"

}

]

}

"subject": {

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "198001022386"

}

"date": "2025-10-07",

"period": {

"start": "2025-10-07"

"grantor": [

{

"type": "Patient",

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "198001022386"

}

"regulatoryBasis": [

{

"coding": [

{

"system": "https://eur-lex.europa.eu/eli/reg/2025/327/oj",

"code": "Article10"

}

]

}

"decision": "deny",

"provision": [

{

"actor": [

{

"reference": {

"identifier": {

"system": "urn:iso:std:iso:3166",

"value": "SE"

}

]

}

]

}

Restrict access to data from caregiver

This example shows how to use Restriction to express restricting access to data from a caregiver. This is done by using a nested provision that points to data that is authored by a caregiver, using the caregiver's organization identifier (system ID is urn:oid:2.5.4.97) as business identifier and setting the meaning of the data reference to "authoredby".

Overview
JSON

Consent

id : 885ab91c-bdcd-4104-8688-7f9ae7c37961

status : active

category

coding

system : http://electronichealth.se/CodeSystem/consent-category

code : restriction

subject

identifier

system : http://electronichealth.se/identifier/personnummer

value : 198001022386

date : 2025-10-07

period

start : 2025-10-07

grantor

type : Patient

identifier

system : http://electronichealth.se/identifier/personnummer

value : 198001022386

decision : deny

provision

data

meaning : authoredby

reference

identifier

system : urn:oid:2.5.4.97

value : 165560269986

{

"resourceType": "Consent",

"id": "885ab91c-bdcd-4104-8688-7f9ae7c37961",

"status": "active",

"category": [

{

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/consent-category",

"code": "restriction"

}

]

}

"subject": {

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "198001022386"

}

"date": "2025-10-07",

"period": {

"start": "2025-10-07"

"grantor": [

{

"type": "Patient",

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "198001022386"

}

"decision": "deny",

"provision": [

{

"provision": [

{

"data": [

{

"meaning": "authoredby",

"reference": {

"identifier": {

"system": "urn:oid:2.5.4.97",

"value": "165560269986"

}

]

}

]

}

]

}

Supported operations

HTTP methods

The following table explains what HTTP methods can be done on the Consent resource using this profile.

Operation	Supported	Comment
Search (GET, POST)	yes
Insert (POST)	no	Use operation ProcessRestriction
Update (PUT)	no	Use extended update operations
Delete (DEL)	no	Use operation RevokeConsent to set status to inactive
Operation (GET, POST)	yes

Query operations

Supported Queries

GET [base]/Consent/[LogicalId] returns the Consent with the supplied logical ID if found, otherwise a 404 HTTP status code.
GET [base]/Consent?patient:identifier=[system]|[value]{&[parameters]} returns a Bundle of Consents where the patient with supplied identifier is the subject and that match the additional parameters if any. If no Consents are found the Bundle will be empty.

Search parameters

Parameter	Description	Example
category	Category of Consent resource, e.g. restriction, opt-out, as "code system\|code"	`category=http://electronichealth.se/CodeSystem/consent-category\|restriction`
patient:identifier	Identifier of subject of Consent, as "system\|value"	`patient:identifier=http://electronichealth.se/identifier/personnummer\|198001012345`

Include/Revinclude parameters

Adding an include or revinclude parameter will result in a Bundle containing the Consents that match the other search parameters as well as the referenced resources supplied in the include or revinclude parameters.

Parameter	Description
`_include=Consent:data:Organization`	Includes the Organizations that are sources to the data to which access is being restricted, for the Restrictions that contain such a data source.
`_include=Consent:grantee:RelatedPerson`	Includes the RelatedPersons representing the roles whose access to the data is being restricted, for the Restrictions where the grantee is defined this way.

Example of response from using include parameter

Overview
JSON

Bundle

id : e813d64f-d564-416f-ae6c-66e6c2472494

type : searchset

link

relation : self

url : [base]/Consent?patient:identifier=http://electronichealth.se/identifier/personnummer|200001032390&category=http://electronichealth.se/CodeSystem/fhir/ndi-consent-category|restriction&_include=Consent:grantee:RelatedPerson

entry

fullUrl : [base]/Consent/9BDDA36F-DB9E-4847-B451-635DA047D104

resource

id : 9BDDA36F-DB9E-4847-B451-635DA047D104

status : active

category

coding

system : http://electronichealth.se/CodeSystem/consent-category

code : restriction

subject

identifier

system : http://electronichealth.se/identifier/personnummer

value : 200001032390

date : 2025-10-07

period

start : 2025-10-07

grantor

type : Patient

identifier

system : http://electronichealth.se/identifier/personnummer

value : 200001032390

grantee

reference : urn:uuid:8E61CF5B-2945-426C-8DFC-CAB78CB0AD3A

type : RelatedPerson

decision : deny

entry

fullUrl : urn:uuid:8E61CF5B-2945-426C-8DFC-CAB78CB0AD3A

resource

id : 8E61CF5B-2945-426C-8DFC-CAB78CB0AD3A

patient

identifier

system : http://electronichealth.se/identifier/personnummer

value : 200001032390

relationship

coding

system : http://terminology.hl7.org/CodeSystem/v3-RoleClass

code : GUARD

{

"resourceType": "Bundle",

"id": "e813d64f-d564-416f-ae6c-66e6c2472494",

"type": "searchset",

"link": [

{

"relation": "self",

"url": "[base]/Consent?patient:identifier=http://electronichealth.se/identifier/personnummer|200001032390&category=http://electronichealth.se/CodeSystem/fhir/ndi-consent-category|restriction&_include=Consent:grantee:RelatedPerson"

}

"entry": [

{

"fullUrl": "[base]/Consent/9BDDA36F-DB9E-4847-B451-635DA047D104",

"resource": {

"resourceType": "Consent",

"id": "9BDDA36F-DB9E-4847-B451-635DA047D104",

"status": "active",

"category": [

{

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/consent-category",

"code": "restriction"

}

]

}

"subject": {

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "200001032390"

}

"date": "2025-10-07",

"period": {

"start": "2025-10-07"

"grantor": [

{

"type": "Patient",

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "200001032390"

}

"grantee": [

{

"reference": "urn:uuid:8E61CF5B-2945-426C-8DFC-CAB78CB0AD3A",

"type": "RelatedPerson"

}

"decision": "deny"

}

{

"fullUrl": "urn:uuid:8E61CF5B-2945-426C-8DFC-CAB78CB0AD3A",

"resource": {

"resourceType": "RelatedPerson",

"id": "8E61CF5B-2945-426C-8DFC-CAB78CB0AD3A",

"patient": {

"identifier": {

"system": "http://electronichealth.se/identifier/personnummer",

"value": "200001032390"

}

"relationship": [

{

"coding": [

{

"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",

"code": "GUARD"

}

]

}

]

}

]

}

Create operations

ProcessRestriction

Sends one or more restrictions in a Bundle to be processed.

Invocations

POST [base]/$process-restriction

Parameters (In)

Name	Cardinality	Type
restrictionBundle	1..1	Bundle

The restrictionBundle should contain a list of entries. Every entry contains a request element that should specify what method the server should interpret the operation for that entry as - POST or PUT. The url element should contain the resource type, e.g. Consent. The actual resource should go in the entry.resource element. See the snippet below showing these elements in a Bundle:

{
    "parameter": [
        {
            "name": "restrictionBundle",
            "resource": {
                "resourceType": "Bundle",
                "type": "transaction",
                "entry": [
                    {
                        "request": {
                            "method": "POST",
                            "url": "Consent"
                        },
                        "resource": {
                            "resourceType": "Consent",
                            "id": "39565af2-9ea6-4504-a1f0-857380ddfedd",
                [...]
    ]
}

Each resource that is being created must have a temporary id that should be used when the resource is referenced to by other related resources. Each resource that is being updated must have the resource's existing id.

Return Values (Out)

Name	Cardinality	Type	Documentation
outcome	1..1	OperationOutcome	OperationOutcome with result of operation.
restriction	0..*	Reference	References to logical IDs of created Restrictions.

Validation messages

Validation messages are error, information or success messages that are returned as a result of an operation. These messages are returned in an OperationOutcome. The transaction can fail because of invalid format of elements in the entries - these error messages are documented in the Profile section. The following validation messages pertain to the operation.

An OperationOutcome contains an array of issues (which can be successful), where each issue has a details element containing a message and when relevant an expression element containing the path to the element which the message pertains to.

Message	Description	Severity
4-XX-300: Spärr har bearbetats	Restriction has been processed successfully	Success
2-XX-8: Bearbetning av spärr misslyckades på grund av mottagarsystem	Processing of restriction has failed because of recipient systems	Error

Examples of request bodies

Create an opt out

The following request body example is a Parameters resource containing a transaction Bundle that contains one entry with the Restriction and the request method set to POST.

Overview
JSON

Parameters

id : ProcessRestriction-OptOut-RequestBody

parameter

name : restrictionBundle

resource

id : ccca31b2-d307-492d-841c-50c5f73d2822

type : transaction

entry

resource

id : 39565af2-9ea6-4504-a1f0-857380ddfedd

status : active

category

coding

system : http://electronichealth.se/CodeSystem/consent-category

code : restriction-optout

category

coding

system : http://electronichealth.se/CodeSystem/consent-category

code : restriction

subject

identifier

system : http://electronichealth.se/identifier/personnummer

value : 198001022386

date : 2025-10-07

period

start : 2025-10-07

grantor

type : Patient

identifier

system : http://electronichealth.se/identifier/personnummer

value : 198001022386

regulatoryBasis

coding

system : https://eur-lex.europa.eu/eli/reg/2025/327/oj

code : Article10

decision : deny

request

method : POST

url : Consent

{

"resourceType": "Parameters",

"id": "ProcessRestriction-OptOut-RequestBody",

"parameter": [

{

"name": "restrictionBundle",

"resource": {

"resourceType": "Bundle",
"id": "ccca31b2-d307-492d-841c-50c5f73d2822",
"type": "transaction",
"entry": [
{
"resource": {
"resourceType": "Consent",
"id": "39565af2-9ea6-4504-a1f0-857380ddfedd",
"status": "active",
"category": [
{
"coding": [
{
"system": "http://electronichealth.se/CodeSystem/consent-category",
"code": "restriction-optout"
}
]
},
{
"coding": [
{
"system": "http://electronichealth.se/CodeSystem/consent-category",
"code": "restriction"
}
]
}
],
"subject": {
"identifier": {
"system": "http://electronichealth.se/identifier/personnummer",
"value": "198001022386"
}
},
"date": "2025-10-07",
"period": {
"start": "2025-10-07"
},
"grantor": [
{
"type": "Patient",
"identifier": {
"system": "http://electronichealth.se/identifier/personnummer",
"value": "198001022386"
}
}
],
"regulatoryBasis": [
{
"coding": [
{
"system": "https://eur-lex.europa.eu/eli/reg/2025/327/oj",
"code": "Article10"
}
]
}
],
"decision": "deny"
},
"request": {
"method": "POST",
"url": "Consent"
}
}
]

}

]

}

Create a restriction against legal guardians

The following example is a Parameters resource containing a transaction Bundle that contains one entry with the Restriction and the request method set to POST and one entry with the RelatedPerson instance that is referenced to in the Consent.grantee.reference element and the request method set to POST.

Overview
JSON

Parameters

id : ProcessRestriction-RestrictLegalGuardian-RequestBody

parameter

name : restrictionBundle

resource

id : 48dfef8f-9ba6-4fcf-a59a-aa66fb35a498

type : transaction

entry

fullUrl : urn:uuid:eddb403b-4b73-47e2-a766-d51866674ba8

resource

id : eddb403b-4b73-47e2-a766-d51866674ba8

status : active

category

coding

system : http://electronichealth.se/CodeSystem/consent-category

code : restriction

subject

identifier

system : http://electronichealth.se/identifier/personnummer

value : 200001032390

date : 2025-10-07

period

start : 2025-10-07

grantor

type : Patient

identifier

system : http://electronichealth.se/identifier/personnummer

value : 200001032390

grantee

reference : urn:uuid:d3d22824-6ded-4d05-a79c-6cc00ab8010a

type : RelatedPerson

decision : deny

request

method : POST

url : Consent

entry

fullUrl : urn:uuid:d3d22824-6ded-4d05-a79c-6cc00ab8010a

resource

id : d3d22824-6ded-4d05-a79c-6cc00ab8010a

patient

identifier

system : http://electronichealth.se/identifier/personnummer

value : 200001032390

relationship

coding

system : http://terminology.hl7.org/CodeSystem/v3-RoleClass

code : GUARD

request

method : POST

url : RelatedPerson

{

"resourceType": "Parameters",

"id": "ProcessRestriction-RestrictLegalGuardian-RequestBody",

"parameter": [

{

"name": "restrictionBundle",

"resource": {

"resourceType": "Bundle",
"id": "48dfef8f-9ba6-4fcf-a59a-aa66fb35a498",
"type": "transaction",
"entry": [
{
"fullUrl": "urn:uuid:eddb403b-4b73-47e2-a766-d51866674ba8",
"resource": {
"resourceType": "Consent",
"id": "eddb403b-4b73-47e2-a766-d51866674ba8",
"status": "active",
"category": [
{
"coding": [
{
"system": "http://electronichealth.se/CodeSystem/consent-category",
"code": "restriction"
}
]
}
],
"subject": {
"identifier": {
"system": "http://electronichealth.se/identifier/personnummer",
"value": "200001032390"
}
},
"date": "2025-10-07",
"period": {
"start": "2025-10-07"
},
"grantor": [
{
"type": "Patient",
"identifier": {
"system": "http://electronichealth.se/identifier/personnummer",
"value": "200001032390"
}
}
],
"grantee": [
{
"reference": "urn:uuid:d3d22824-6ded-4d05-a79c-6cc00ab8010a",
"type": "RelatedPerson"
}
],
"decision": "deny"
},
"request": {
"method": "POST",
"url": "Consent"
}
},
{
"fullUrl": "urn:uuid:d3d22824-6ded-4d05-a79c-6cc00ab8010a",
"resource": {
"resourceType": "RelatedPerson",
"id": "d3d22824-6ded-4d05-a79c-6cc00ab8010a",
"patient": {
"identifier": {
"system": "http://electronichealth.se/identifier/personnummer",
"value": "200001032390"
}
},
"relationship": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"code": "GUARD"
}
]
}
]
},
"request": {
"method": "POST",
"url": "RelatedPerson"
}
}
]

}

]

}

Examples of responses

Successful operation

If a restriction is processed successfully, the response will be a OperationOutcome with an issue detailing the success. The issue will have severity set to information and code to success. The expression element details which entry in the Bundle the message pertains to.

Overview
JSON

Parameters

id : 9ccf26eb-9b76-421c-b63c-bb70b6deac54

parameter

name : outcome

resource

id : 00abe52a-9a08-4f60-ab20-3ca6aacaa01f

issue

severity : success

code : success

details

coding

system : http://electronichealth.se/CodeSystem/error-codes

code : 4-XX-300

display : Spärr har bearbetats.

expression : Bundle.entry[1]

parameter

name : restriction

value

reference : Consent/39565af2-9ea6-4504-a1f0-857380ddfedd

{

"resourceType": "Parameters",

"id": "9ccf26eb-9b76-421c-b63c-bb70b6deac54",

"parameter": [

{

"name": "outcome",

"resource": {

"resourceType": "OperationOutcome",

"id": "00abe52a-9a08-4f60-ab20-3ca6aacaa01f",

"issue": [

{

"severity": "success",

"code": "success",

"details": {

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "4-XX-300",
"display": "Spärr har bearbetats."

}

]

"expression": [

"Bundle.entry[1]"

]

}

]

}

{

"name": "restriction",

"valueReference": {

"reference": "Consent/39565af2-9ea6-4504-a1f0-857380ddfedd"

}

]

}

Failed operation because of request format

If the processing of a restriction fails because of invalid formatting of the content of the request body, the response will be a OperationOutcome with an issue detailing the error. The issue will have severity set to error and code to value. The expression element details which entry and element in the Bundle the message pertains to.

Overview
JSON

OperationOutcome

id : 0e1f84be-2595-4d30-b302-5bb6ee352ef7

issue

severity : error

code : value

details

coding

system : http://electronichealth.se/CodeSystem/error-codes

code : 2-XX-4

display : Ogiltigt system-ID.

expression : Parameters.parameter[0].resource.entry[0].resource.grantee.identifier.system

{

"resourceType": "OperationOutcome",

"id": "0e1f84be-2595-4d30-b302-5bb6ee352ef7",

"issue": [

{

"severity": "error",

"code": "value",

"details": {

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "2-XX-4",
"display": "Ogiltigt system-ID."

}

]

"expression": [

"Parameters.parameter[0].resource.entry[0].resource.grantee.identifier.system"

]

}

]

}

Failed operation because of processing error

If the processing of a restriction fails because of an unknown error thrown by the recipient system, the response will be a OperationOutcome with an issue detailing the error. The issue will have severity set to error and code to transient. The expression element details which entry in the Bundle the message pertains to.

Overview
JSON

OperationOutcome

id : 83f4e61e-673f-41e7-8624-20feef72ed11

issue

severity : error

code : transient

details

coding

system : http://electronichealth.se/CodeSystem/error-codes

code : 2-XX-8

display : Bearbetning av spärr misslyckades på grund av mottagarsystem.

expression : Parameters.parameter[0].resource.entry[0]

{

"resourceType": "OperationOutcome",

"id": "83f4e61e-673f-41e7-8624-20feef72ed11",

"issue": [

{

"severity": "error",

"code": "transient",

"details": {

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "2-XX-8",
"display": "Bearbetning av spärr misslyckades på grund av mottagarsystem."

}

]

"expression": [

"Parameters.parameter[0].resource.entry[0]"

]

}

]

}

Update operations

RevokeConsent

Revokes a Consent resource.

Revoking a Restriction will set its status to inactive.

Invocations

POST [base]/Consent/[id]/$revoke

Parameters (In)

Name	Cardinality	Type	Documentation
revokedBy	1..1	Identifier	Identifier of person who is revoking the Restriction, with system and value.

If the person who is revoking is a patient or related person, current valid identifiers are:

Personal identity number (sv: personnummer)
- system: http://electronichealth.se/identifier/personnummer
- value format: 12 digits without hyphen, e.g. 198001032385
Coordination number (sv: samordningsnummer)
- system: http://electronichealth.se/identifier/samordningsnummer
- value format: 12 digits without hyphen, e.g. 201903682399

If the person who is revoking is a healthcare professional, current valid identifiers are:

HSA ID
- system: urn:oid:1.2.752.29.4.19
- value format: SE+10 digits+hyphen+a number of alphanumerical characters, e.g. SE1234567890-ABC1

Return Values (Out)

Name	Cardinality	Type	Documentation
return	1..1	OperationOutcome	OperationOutcome with result of operation

Validation messages

Validation messages are error, information or success messages that are returned as a result of an operation. These messages are returned in a OperationOutcome resource.

Parameter	Error message	Description	Severity
revokedBy.value	2-XX-2: Ogiltigt format på personnummer. Ange tolvsiffriga personnumret utan bindestreck, t. ex. 198001032385.	Personal identity number should be 12 digits without hyphen	Error
revokedBy.value	2-XX-3: Ogiltigt format på samordningsnummer. Ange tolvsiffriga samordningsnumret utan bindestreck, t. ex. 201903682399.	Coordination number should be 12 digits without hyphen	Error
revokedBy.system	2-XX-4: Ogiltigt system-ID.	The identifier system value must be be from list of valid systems (see section "Parameters (In)" above)	Error
revokedBy	2-XX-9: Parametern %s saknas.	Parameters with cardinality 1..N must be supplied	Error
id	2-XX-10: Spärr med id %s hittades inte.	Restriction with supplied logical ID not found	Error
revokedBy	2-XX-11: Angiven person är inte behörig att återkalla spärren.	Person supplied to revoke Restriction is unauthorized.	Error
	4-XX-2: Spärren har återkallats.	Restriction revoked successfully.	Success
	4-XX-3: Spärren är redan återkallad.	Authorization was already revoked.	Information

Examples of requests

Invocation: POST [base]/Consent/442b7631-8503-4b38-83d8-59c4e1ed800c/$revoke

Request body:

Overview
JSON

Parameters

id : RevokeConsent-CoordinationNumber-RequestBody

parameter

name : revokedBy

value

system : http://electronichealth.se/identifier/samordningsnummer

value : 201903682399

{

"resourceType": "Parameters",

"id": "RevokeConsent-CoordinationNumber-RequestBody",

"parameter": [

{

"name": "revokedBy",

"valueIdentifier": {

"system": "http://electronichealth.se/identifier/samordningsnummer",

"value": "201903682399"

}

]

}

Examples of responses

Successful operation

A successful operation returns an OperationOutcome with issue.severity and issue.code both set to "success".

Overview
JSON

OperationOutcome

id : 20f45ca2-5759-436d-a0c3-cb4b71c4947e

issue

severity : success

code : success

details

coding

system : http://electronichealth.se/CodeSystem/error-codes

code : 4-XX-2

display : Spärren har återkallats.

{

"resourceType": "OperationOutcome",

"id": "20f45ca2-5759-436d-a0c3-cb4b71c4947e",

"issue": [

{

"severity": "success",

"code": "success",

"details": {

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "4-XX-2",
"display": "Spärren har återkallats."

}

]

}

]

}

Already revoked

If the Restriction has already been revoked, the response will be an OperationOutcome with issue.severity set to "information" and issue.code set to "processing".

Overview
JSON

OperationOutcome

id : efa70f25-3ffb-4bc7-81b1-8e95d9ba0676

issue

severity : information

code : processing

details

coding

system : http://electronichealth.se/CodeSystem/error-codes

code : 4-XX-3

display : Spärren är redan återkallad.

{

"resourceType": "OperationOutcome",

"id": "efa70f25-3ffb-4bc7-81b1-8e95d9ba0676",

"issue": [

{

"severity": "information",

"code": "processing",

"details": {

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "4-XX-3",
"display": "Spärren är redan återkallad."

}

]

}

]

}

Failed operation

A failed operation returns an OperationOutcome with an issue.severity set to "error".

The following example shows a response when the person with the supplied identifier in parameter revokedBy is unauthorized to revoke a Restriction. The response is an OperationOutcome with issue.code set to "forbidden".

Overview
JSON

OperationOutcome

id : abee7942-37c6-48d5-a149-71c723e4d4cb

issue

severity : error

code : forbidden

details

coding

system : http://electronichealth.se/CodeSystem/error-codes

code : 2-XX-11

display : Angiven person är inte behörig att återkalla spärren.

{

"resourceType": "OperationOutcome",

"id": "abee7942-37c6-48d5-a149-71c723e4d4cb",

"issue": [

{

"severity": "error",

"code": "forbidden",

"details": {

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "2-XX-11",
"display": "Angiven person är inte behörig att återkalla spärren."

}

]

}

]

}

The following example shows a response when the supplied logical ID was not found. The issue.code element is set to "not-found".

Overview
JSON

OperationOutcome

id : 76063dec-4de7-45c2-a559-3432f147a317

issue

severity : error

code : not-found

details

coding

system : http://electronichealth.se/CodeSystem/error-codes

code : 2-XX-6

display : Spärr med id ed3cbdbb-97de-4573-b9e0-d7422b8c2696 hittades inte.

{

"resourceType": "OperationOutcome",

"id": "76063dec-4de7-45c2-a559-3432f147a317",

"issue": [

{

"severity": "error",

"code": "not-found",

"details": {

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "2-XX-6",
"display": "Spärr med id ed3cbdbb-97de-4573-b9e0-d7422b8c2696 hittades inte."

}

]

}

]

}

UpdateConsentEffectivePeriod

Updates effective period of a Consent resource.

Invocations

POST [base]/Consent/[id]/$update-period

Parameters (In)

Name	Cardinality	Type	Documentation
updatedBy	1..1	Identifier	Identifier of person who is updating the Consent, with system and value.
period	1..1	Period	New effective period of Consent, with at least start time supplied.

If the person who is requesting the update is a patient or related person, current valid identifiers are:

Personal identity number (sv: personnummer)
- system: http://electronichealth.se/identifier/personnummer
- value format: 12 digits without hyphen, e.g. 198001032385
Coordination number (sv: samordningsnummer)
- system: http://electronichealth.se/identifier/samordningsnummer
- value format: 12 digits without hyphen, e.g. 201903682399

If the person who is requesting the update is a healthcare professional, current valid identifiers are:

HSA ID
- system: urn:oid:1.2.752.29.4.19
- value format: SE+10 digits+hyphen+a number of alphanumerical characters, e.g. SE1234567890-ABC1

Return Values (Out)

Name	Cardinality	Type	Documentation
return	1..1	OperationOutcome	OperationOutcome with result of operation

Validation messages

Validation messages are error, information or success messages that are returned as a result of an operation. These messages are returned in a OperationOutcome resource.

Parameter	Error message	Description	Severity
updatedBy	2-XX-11: Angiven person är inte behörig att ändra spärren.	Person supplied to alter Restriction is unauthorized.	Error
updatedBy.value	2-XX-2: Ogiltigt format på personnummer. Ange tolvsiffriga personnumret utan bindestreck, t. ex. 198001032385.	Personal identity number should be 12 digits without hyphen	Error
updatedBy.value	2-XX-3: Ogiltigt format på samordningsnummer. Ange tolvsiffriga samordningsnumret utan bindestreck, t. ex. 201903682399.	Coordination number should be 12 digits without hyphen	Error
updatedBy.system	2-XX-4: Ogiltigt system-ID.	The identifier system value must be be from list of valid systems (see section "Parameters (In)" above)	Error
updatedBy, period, period.start	2-XX-9: Parametern %s saknas.	Parameters with cardinality 1..N must be supplied	Error
id	2-XX-10: Spärr med id %s hittades inte.	Restriction with supplied logical ID not found	Error
period	2-XX-15: Slutdatum måste vara samtidigt som eller senare än startdatum.	If present, start SHALL have a lower or equal value than end	Error
period.start, period.end	2-XX-17: Datum ska vara ett giltigt datum som anges på formatet YYYY-MM-DD utan tidsangivelse	DateTime must be a valid date that follows format YYYY-MM-DD without timestamp	Error
period.start, period.end	2-XX-14: Start- och slutdatum får inte vara passerade datum.	Period.start and period.end SHALL have higher or equal values than today's date	Error
period.start, period.end	2-XX-16: Ett passerat start- eller slutdatum får inte ändras.	If the existing start or end date has passed it cannot be altered.	Error
	4-XX-4: Spärren har uppdaterats.	Restriction period updated successfully.	Success

Examples of requests

Invocation: POST [base]/Consent/442b7631-8503-4b38-83d8-59c4e1ed800c/$update-period

Request body:

Overview
JSON

Parameters

id : UpdateConsentEffectivePeriod-CoordinationNumber-RequestBody

parameter

name : updatedBy

value

system : http://electronichealth.se/identifier/samordningsnummer

value : 201903682399

parameter

name : period

value

start : 2026-05-01

end : 2027-05-01

{

"resourceType": "Parameters",

"id": "UpdateConsentEffectivePeriod-CoordinationNumber-RequestBody",

"parameter": [

{

"name": "updatedBy",

"valueIdentifier": {

"system": "http://electronichealth.se/identifier/samordningsnummer",

"value": "201903682399"

}

{

"name": "period",

"valuePeriod": {

"start": "2026-05-01",

"end": "2027-05-01"

}

]

}

Examples of responses

A failed operation returns an OperationOutcome with an issue.severity set to "error".

Invalid period

The following example shows the response for when end is supplied and has a lower value than start, resulting in an invalid period. The response is an OperationOutcome with issue.code set to "value".

Overview
JSON

OperationOutcome

id : 98c7d67f-fa5c-4162-8724-1fe20953a1e5

issue

severity : error

code : value

details

coding

system : http://electronichealth.se/CodeSystem/error-codes

code : 2-XX-15

display : Slutdatum måste komma efter startdatum.

{

"resourceType": "OperationOutcome",

"id": "98c7d67f-fa5c-4162-8724-1fe20953a1e5",

"issue": [

{

"severity": "error",

"code": "value",

"details": {

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "2-XX-15",
"display": "Slutdatum måste komma efter startdatum."

}

]

}

]

}

Existing period has passed

The following example shows the response for when existing start and/or end date has passed and thus cannot be altered. The response is an OperationOutcome with issue.code set to "business-rule".

Overview
JSON

OperationOutcome

id : 1ac2f160-eaa7-44d6-a0c0-08803a6eb797

issue

severity : error

code : business-rule

details

coding

system : http://electronichealth.se/CodeSystem/error-codes

code : 2-XX-16

display : Ett passerat start- eller slutdatum får inte ändras.

{

"resourceType": "OperationOutcome",

"id": "1ac2f160-eaa7-44d6-a0c0-08803a6eb797",

"issue": [

{

"severity": "error",

"code": "business-rule",

"details": {

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "2-XX-16",
"display": "Ett passerat start- eller slutdatum får inte ändras."

}

]

}

]

}

Requested new period has passed

The following example shows the response for when the requested start and/or end date has passed. The response is an OperationOutcome with issue.code set to "value".

Overview
JSON

OperationOutcome

id : 1446c41c-ae48-4d41-8ae2-e53400629da1

issue

severity : error

code : value

details

coding

system : http://electronichealth.se/CodeSystem/error-codes

code : 2-XX-14

display : Start- och slutdatum får inte vara passerade datum.

{

"resourceType": "OperationOutcome",

"id": "1446c41c-ae48-4d41-8ae2-e53400629da1",

"issue": [

{

"severity": "error",

"code": "value",

"details": {

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "2-XX-14",
"display": "Start- och slutdatum får inte vara passerade datum."

}

]

}

]

}

Resource Profile: Consent - Restriction

General information

Scope and Usage

Profile

Details

For whom - To whose data is access being restricted

By whom - Who created the restriction

Patient or related person

Healthcare professional

Against whom - Whose access is being restricted

Patient or related person

Healthcare practitioner

Country

Healthcare provider

Healthcare unit

When - During what time frame is access being restricted

What - To what data is access being restricted

Define data by its source

Define data by information category

Reference to instance of data

ValueSet bindings

Validation rules

General

Invariants

Business rules

Examples

Opt out

Restrict access of legal guardians using role

Restriction

Legal guardian

Restrict access of related person or practitioner using identifier

Restrict access of all EU countries but Sweden

Restrict access to data from caregiver

Supported operations

HTTP methods

Query operations

Supported Queries

Search parameters

Include/Revinclude parameters

Create operations

ProcessRestriction

Invocations

Parameters (In)

Return Values (Out)

Validation messages

Examples of request bodies

Examples of responses

Update operations

RevokeConsent

Invocations

Parameters (In)

Return Values (Out)

Validation messages

Examples of requests

Examples of responses

UpdateConsentEffectivePeriod

Invocations

Parameters (In)

Return Values (Out)

Validation messages

Examples of requests

Examples of responses