| Consent | I | | Consent | There are no (further) constraints on this element Element IdShort description A healthcare consumer'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, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives.
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-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() - ppc-4:IF Scope=adr, there must be a patient
patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() - ppc-5:IF Scope=treatment, there must be a patient
patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() - ppc-2:IF Scope=privacy, there must be a patient
patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() - ppc-3:IF Scope=research, there must be a patient
patient.exists() or scope.coding.where(system='something' and code='research').exists().not() - ppc-1:Either a Policy or PolicyRule
policy.exists() or policyRule.exists()
- rim:Entity. Role, or Act
- workflow:Event
- v2:CON
- rim:FinancialConsent
|
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element IdShort 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.
Meta Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdShort 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
Extension Sliced: Unordered, Open, by url(Value) 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()
|
| created | S I | 0..1 | Extension(instant) | Element IdConsent.meta.extension:created Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources.
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.
Extension(instant) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/Created 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()
|
| versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdShort description Version specific identifier Definition The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
id Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdShort description When the resource version last changed Definition When the resource last changed - e.g. when the version changed.
This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
instant Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdShort description Identifies where the resource comes from Definition A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.
This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| profile | Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element IdShort description Profiles this resource claims to conform to Definition Comments It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
canonical(StructureDefinition) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdShort description Security Labels applied to this resource Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Coding Binding Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
|
| tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdShort description Tags applied to this resource Definition Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Coding Binding Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
|
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdShort 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
Extension Sliced: Unordered, Open, by url(Value) 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()
|
| domainReference | S I | 0..* | Extension(Complex) | There are no (further) constraints on this element Element IdConsent.extension:domainReference Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources.
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.
Extension(Complex) Extension URL http://fhir.de/ConsentManagement/StructureDefinition/DomainReference 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()
|
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
Extension Sliced: Unordered, Open, by url(Value) 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()
|
| domain | S I | 1..1 | Extension | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:domain 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
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()
|
| url | | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:domain.url identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
System.String Fixed Value Mappings |
| value[x] | | 1..1 | | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:domain.value[x] Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| reference | Σ I | 1..1 | string | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:domain.value[x].reference 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:domain.value[x].type Type the reference refers to (e.g. "Patient") 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).
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
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())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:domain.value[x].identifier 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:domain.value[x].display Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| valueReference | | | Reference(Consent Management Domain Organization | Consent Management Domain Research Study) | There are no (further) constraints on this element Data Type Reference(Consent Management Domain Organization | Consent Management Domain Research Study) |
| status | I | 0..1 | Extension | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:status 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
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()
|
| url | | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:status.url identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
System.String Fixed Value Mappings |
| value[x] | | 1..1 | Binding | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:status.value[x] Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
PublicationStatus (required) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| valueCoding | | | Coding | There are no (further) constraints on this element Data Type Coding |
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:status.value[x].system Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code.
Need to be unambiguous about the source of the definition of the symbol.
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 reference to some definition that establishes the system clearly and unambiguously.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.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 IdConsent.extension:domainReference.extension:status.value[x].version 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.7
- rim:./codeSystemVersion
- orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:status.value[x].code 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).
Need to refer to a particular code in the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.1
- rim:./code
- orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:status.value[x].display Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.2 - but note this is not well followed
- rim:CV.displayName
- orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdConsent.extension:domainReference.extension:status.value[x].userSelected 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).
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.
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.
boolean Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 ]
|
| url | | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdConsent.extension:domainReference.url identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
System.String Fixed Value
http://fhir.de/ConsentManagement/StructureDefinition/DomainReference Mappings |
| value[x] | | 0..0 | | There are no (further) constraints on this element Element IdConsent.extension:domainReference.value[x] Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| externalProperty | S I | 0..* | Extension(Complex) | Element IdConsent.extension:externalProperty ExternalProperty Alternate names extensions, user content Definition 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.
Extension(Complex) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty 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()
|
| expirationProperty | S I | 0..* | Extension(Complex) | Element IdConsent.extension:expirationProperty Expiration Property Alternate names extensions, user content Definition 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.
Extension(Complex) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/ExpirationProperty 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()
|
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdShort description Identifier for this record (external references) Definition Unique identifier for this copy of the Consent Statement.
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.
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
General{
"system": "urn:ietf:rfc:3986",
"value": "Local eCMS identifier"
}
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
- rim:.id
|
| status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdShort description draft | proposed | active | rejected | inactive | entered-in-error Definition Indicates the current state of this consent.
The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.
This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.
code Binding Indicates the state of the consent. ConsentState (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- workflow:Event.status
- w5:FiveWs.status
- v2:HL7 Table 0498 - Consent Status
- rim:.statusCode
|
| scope | Σ ?! | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdShort description Which of the four areas this resource covers (extensible) Definition A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.
Wird im Kontext des Einwilligungsmanagment-Leitfadens nicht näher definiert.
Bei Bedarf kann das ValueSet erweitert oder ggf. ein NullFlavor-Code eingetragen werden.
CodeableConcept Binding The four anticipated uses for the Consent Resource. ConsentScopeCodes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
|
| category | S Σ | 1..* | CodeableConceptBinding | Element IdShort 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.
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.
CodeableConcept Sliced: Unordered, Open, by $this(Type)
Binding A classification of the type of consents found in a consent statement. ConsentCategoryCodes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:Event.code
- w5:FiveWs.class
- v2:HL7 Table 0497 - Consent Type
- rim:CNTRCT
|
| coding | S Σ | 1..* | Coding | There are no (further) constraints on this element Element IdShort description Code defined by a terminology system Definition A reference to a code defined by a terminology system.
Allows for alternative encodings within a code system, and translations to other code systems.
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.
Coding Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- v2:C*E.1-8, C*E.10-22
- rim:union(., ./translation)
- orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdShort 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.
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.
Very often the text is the same as a displayName of one of the codings.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.9. But note many systems use C*E.2 for this
- rim:./originalText[mediaType/code="text/plain"]/data
- orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
| consentCategoryCodes | S Σ | 1..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdConsent.category:consentCategoryCodes 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.
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.
CodeableConcept Binding A classification of the type of consents found in a consent statement. ConsentCategoryCodes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:Event.code
- w5:FiveWs.class
- v2:HL7 Table 0497 - Consent Type
- rim:CNTRCT
|
| coding | S Σ | 1..1 | Coding | There are no (further) constraints on this element Element IdConsent.category:consentCategoryCodes.coding Code defined by a terminology system Definition A reference to a code defined by a terminology system.
Allows for alternative encodings within a code system, and translations to other code systems.
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.
Coding Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- v2:C*E.1-8, C*E.10-22
- rim:union(., ./translation)
- orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdConsent.category:consentCategoryCodes.coding.system Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code.
Need to be unambiguous about the source of the definition of the symbol.
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 reference to some definition that establishes the system clearly and unambiguously.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.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 IdConsent.category:consentCategoryCodes.coding.version 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.7
- rim:./codeSystemVersion
- orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element IdConsent.category:consentCategoryCodes.coding.code 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).
Need to refer to a particular code in the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.1
- rim:./code
- orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdConsent.category:consentCategoryCodes.coding.display Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.2 - but note this is not well followed
- rim:CV.displayName
- orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdConsent.category:consentCategoryCodes.coding.userSelected 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).
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.
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.
boolean Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 IdConsent.category:consentCategoryCodes.text 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.
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.
Very often the text is the same as a displayName of one of the codings.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.9. But note many systems use C*E.2 for this
- rim:./originalText[mediaType/code="text/plain"]/data
- orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
| aggregation | S Σ | 0..1 | CodeableConceptBinding | Element IdConsent.category:aggregation 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.
Information, ob die enthaltenen Einwilligungsinformationen aus allen vorliegenden Einwilligungsfragebögen aggregiert (errechnet) wurden oder lediglich den Inhalt eines Fragebogens von möglicherweise mehreren repräsentiert.
CodeableConcept Binding A classification of the type of consents found in a consent statement. ConsentAggregationLevel (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:Event.code
- w5:FiveWs.class
- v2:HL7 Table 0497 - Consent Type
- rim:CNTRCT
|
| coding | S Σ | 1..1 | Coding | There are no (further) constraints on this element Element IdConsent.category:aggregation.coding Code defined by a terminology system Definition A reference to a code defined by a terminology system.
Allows for alternative encodings within a code system, and translations to other code systems.
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.
Coding Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- v2:C*E.1-8, C*E.10-22
- rim:union(., ./translation)
- orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdConsent.category:aggregation.coding.system Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code.
Need to be unambiguous about the source of the definition of the symbol.
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 reference to some definition that establishes the system clearly and unambiguously.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.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 IdConsent.category:aggregation.coding.version 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.7
- rim:./codeSystemVersion
- orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element IdConsent.category:aggregation.coding.code 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).
Need to refer to a particular code in the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.1
- rim:./code
- orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdConsent.category:aggregation.coding.display Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.2 - but note this is not well followed
- rim:CV.displayName
- orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdConsent.category:aggregation.coding.userSelected 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).
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.
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.
boolean Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 IdConsent.category:aggregation.text 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.
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.
Very often the text is the same as a displayName of one of the codings.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.9. But note many systems use C*E.2 for this
- rim:./originalText[mediaType/code="text/plain"]/data
- orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
| patient | S Σ I | 1..1 | Reference(Consent Management: Patient) | There are no (further) constraints on this element Element IdShort description Who the consent applies to Definition The patient/healthcare consumer to whom this consent applies.
Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.
Reference(Consent Management: Patient) 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- 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]
- rim:Role
- w5:FiveWs.subject
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdConsent.patient.reference 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdShort description Type the reference refers to (e.g. "Patient") 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).
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
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())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdConsent.patient.identifier 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdShort description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| dateTime | S Σ | 1..1 | dateTime | There are no (further) constraints on this element Element IdShort description Erstellungszeitpunkt der Einwilligung Definition Zu diesem Zeitpunkt wurde die hier dokumentierte Einwilligungserklärung erstellt.
Dieser Zeitpunkt sollte in der Praxis, zumindest bei vollelektronischer Verarbeitung, identisch mit dem Unterschriftsdatum des Fragebogens sein (Provenance.signature.when des Patienten)
dateTime Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- workflow:Event.occurrence[x]
- w5:FiveWs.recorded
- v2:Field 13/ Consent Decision Date
- rim:FinancialConsent effectiveTime
|
| performer | Σ I | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | There are no (further) constraints on this element Element IdShort description Who is agreeing to the policy and rules Alternate names consentor Definition Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian.
Reference(Organization | Patient | Practitioner | RelatedPerson | 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:Event.performer
- w5:FiveWs.actor
- v2:Field 24/ ConsenterID
|
| organization | S Σ I | 0..* | Reference(Organization) | There are no (further) constraints on this element Element IdShort description Organisation, in der die Einwilligung erfasst wurde. Alternate names custodian Definition Dies ist die Organisation, die den Consent erfasst hat.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Reference(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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:Event.performer
- w5:FiveWs.witness
|
| source[x] | S Σ | 0..1 | | There are no (further) constraints on this element Element IdShort 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, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.
- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:Field 19 Informational Material Supplied Indicator
|
| reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element IdConsent.source[x].reference 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdShort description Type the reference refers to (e.g. "Patient") 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).
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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
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())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdConsent.source[x].identifier 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdConsent.source[x].display Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| sourceReference | | | Reference(Consent Management QuestionnaireResponse) | There are no (further) constraints on this element Data Type Reference(Consent Management QuestionnaireResponse) |
| policy | S | 0..* | BackboneElement | There are no (further) constraints on this element Element IdShort description Policies covered by this consent Definition The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| authority | I | 0..1 | uri | There are no (further) constraints on this element Element IdShort description Enforcement source for policy Definition Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.
see http://en.wikipedia.org/wiki/Uniform_resource_identifier
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| uri | S I | 1..1 | uri | There are no (further) constraints on this element Element IdShort description Specific policy covered by this consent Definition The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
This element is for discoverability / documentation and does not modify or qualify the policy rules.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| policyRule | S Σ I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdShort description Regulation that this consents to Definition A reference to the specific base computable regulation or policy.
Might be a unique identifier of a policy set in XACML, or other rules engine.
If the policyRule is absent, computable consent would need to be constructed from the elements of the Consent resource.
CodeableConcept Binding Regulatory policy examples. ConsentPolicyRuleCodes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
|
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdConsent.policyRule.extension 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
Extension Sliced: Unordered, Open, by url(Value) 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()
|
| xacml | S I | 0..1 | Extension(base64Binary) | There are no (further) constraints on this element Element IdConsent.policyRule.extension:xacml Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources.
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.
Extension(base64Binary) Extension URL http://fhir.de/ConsentManagement/StructureDefinition/Xacml 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()
|
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdConsent.policyRule.coding Code defined by a terminology system Definition A reference to a code defined by a terminology system.
Allows for alternative encodings within a code system, and translations to other code systems.
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.
Coding Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- v2:C*E.1-8, C*E.10-22
- rim:union(., ./translation)
- orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdShort 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.
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.
Very often the text is the same as a displayName of one of the codings.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:C*E.9. But note many systems use C*E.2 for this
- rim:./originalText[mediaType/code="text/plain"]/data
- orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
| verification | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdShort 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.
BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| verified | Σ | 1..1 | boolean | There are no (further) constraints on this element Element IdConsent.verification.verified Has been verified Definition Has the instruction been verified.
boolean Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| verifiedWith | I | 0..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element IdConsent.verification.verifiedWith Person who verified Definition Who verified the instruction (Patient, Relative or other Authorized Person).
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Reference(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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
|
| verificationDate | | 0..1 | dateTime | There are no (further) constraints on this element Element IdConsent.verification.verificationDate When consent verified Definition Date verification was collected.
dateTime Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| provision | S Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdShort description Constraints to the base Consent.policyRule Definition An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdShort description deny | permit Definition Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Binding How a rule statement is applied, such as adding additional consent or removing consent. ConsentProvisionType (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| period | S Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdShort description Timeframe for this rule Definition The timeframe in this rule is valid.
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.
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 value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
|
| actor | | 0..* | BackboneElement | There are no (further) constraints on this element Element IdShort description Who|what controlled by this rule (or group, by role) Definition Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
There is no specific actor associated with the exception
BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| role | | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdConsent.provision.actor.role How the actor is involved Definition How the individual is involved in the resources content that is described in the exception.
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
CodeableConcept Binding How an actor is involved in the consent considerations. SecurityRoleType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
|
| reference | I | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | There are no (further) constraints on this element Element IdConsent.provision.actor.reference 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').
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- 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 IdShort description Actions controlled by this rule Definition Actions controlled by this Rule.
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'.
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())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
|
| securityLabel | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdConsent.provision.securityLabel 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.
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.
Coding Binding Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdConsent.provision.purpose Context of activities covered by this rule Definition The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.
When the purpose of use tag is on the data, access request purpose of use shall not conflict.
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. v3.PurposeOfUse (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
|
| class | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdShort description e.g. Resource Type, Profile, CDA, etc. Definition The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.
Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.
Coding Binding The class (type) of information a consent rule covers. ConsentContentClass (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 IdShort description e.g. LOINC or SNOMED CT code, etc. in the content Definition If this code is found in an instance, then the rule applies.
Typical use of this is a Document code with class = CDA.
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())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
|
| dataPeriod | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdConsent.provision.dataPeriod Timeframe for data controlled by this rule Definition Clinical or Operational Relevant period of time that bounds the data controlled by this rule.
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.
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 value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
|
| data | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdShort description Data controlled by this rule Definition The resources controlled by this rule if specific resources are referenced.
BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| meaning | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdConsent.provision.data.meaning instance | related | dependents | authoredby Definition How the resource reference is interpreted when testing consent restrictions.
Note that FHIR strings SHALL NOT exceed 1MB in size
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())
|
| reference | Σ I | 1..1 | Reference(Resource) | There are no (further) constraints on this element Element IdConsent.provision.data.reference The actual data reference Definition A reference to a specific resource that defines which resources are covered by this consent.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
|
| provision | | 0..* | see (provision) | There are no (further) constraints on this element Element IdConsent.provision.provision Nested Exception Rules Definition Rules which provide exceptions to the base rule or subrules.
|
