Page Status: updated 2024-08-28

NLLAccessConsent (Consent)

Page index

Introduction

The Consent resource, shown in the profile NLLAccessConsent (sv: registrerat åtkomstsamtycke) represents a consent for a health care professional to access a patient's medication list.

Regarding information about how the "must support"-property is used in the Swedish National MedicationList, please refer to the page Resources

Overview

idS Σ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedS Σ0..1instant
sourceΣ0..1uri
profileΣ0..*canonical(StructureDefinition)
id0..1string
extensionI0..*Extension
systemS Σ0..1uri
versionS Σ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
id0..1string
extensionI0..*Extension
startS Σ I1..1dateTime
endS Σ I1..1dateTime
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
statusS Σ ?!1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionS Σ0..1string
codeS Σ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionS Σ0..1string
codeS Σ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
dateTimeΣ0..1dateTime
performerΣ0..*Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)
organizationΣ0..*Reference(Organization)
sourceAttachmentAttachment
sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
authorityI0..1uri
uriS I0..1uriFixed Value
policyRuleΣ I0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
verifiedΣ1..1boolean
verifiedWith0..1Reference(Patient | RelatedPerson)
verificationDate0..1dateTime
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..1codeBinding
id0..1string
extensionI0..*Extension
startS Σ I1..1dateTime
endS Σ I1..1dateTime
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionS Σ0..1string
codeS Σ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I0..1string
typeS Σ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
actionΣ0..*CodeableConcept
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionS Σ0..1string
codeS Σ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
purposeΣ0..*CodingBinding
classΣ0..*CodingBinding
codeΣ0..*CodeableConcept
dataPeriodΣ0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
meaningΣ1..1codeBinding
referenceΣ1..1Reference(Resource)
provision0..*see (provision)
Consent
DefinitionA 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.
Cardinality0...*
Comments

This profile is intended for Consents of the type access to information within the Swedish National Medication List (sv. åtkomstsamtycke).

Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • ppc-1: Either a Policy or PolicyRule
    policy.exists() or policyRule.exists()
  • ppc-2: IF Scope=privacy, there must be a patient
    patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
  • ppc-3: IF Scope=research, there must be a patient
    patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
  • ppc-4: IF Scope=adr, there must be a patient
    patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
  • ppc-5: IF Scope=treatment, there must be a patient
    patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • v2: CON
  • rim: FinancialConsent
  • EHM: Registrerat samtycke
Consent.id
DefinitionUUID identifying the consent
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. This id is identified by the URI http://electronichealth.se/identifier/nllconsentid in documentation and external systems.

Mappings
  • EHM: Samtyckes-id
Consent.meta
DefinitionThe 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.
Cardinality0...1
TypeMeta
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.meta.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.meta.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.meta.versionId
DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Cardinality0...1
Typeid
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.meta.lastUpdated
DefinitionWhen the resource last changed - e.g. when the version changed.
Cardinality0...1
Typeinstant
Must SupportTrue
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.meta.source
DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) 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.
Cardinality0...1
Typeuri
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.meta.profile
DefinitionA list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
Cardinality0...*
Typecanonical(StructureDefinition)
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.meta.security
DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Cardinality0...*
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

security-labels (extensible)
Must SupportTrue
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.meta.security.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.meta.security.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.meta.security.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality0...1
Typeuri
Must SupportTrue
SummaryTrue
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 reference to some definition that establishes the system clearly and unambiguously.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Consent.meta.security.version
DefinitionThe 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.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Consent.meta.security.code
DefinitionA 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).
Cardinality0...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Consent.meta.security.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Consent.meta.security.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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.meta.tag
DefinitionTags 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.
Cardinality0...*
TypeCoding
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.implicitRules
DefinitionA 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.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
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).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.text
DefinitionA 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.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
Consent.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...*
TypeResource
Aliasinline 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.

Mappings
  • rim: N/A
Consent.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.extension:nllInqueryPeriod
DefinitionAn access consent with status proposed must have an inquery period. The period starts when the consent was requested and ends when the consent is terminated unless it is approved by the patient.
Cardinality0...1
TypeExtension(Period)
Must SupportTrue
Aliasextensions, 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.

Invariants
  • 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.extension:nllInqueryPeriod.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.extension:nllInqueryPeriod.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.extension:nllInqueryPeriod.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

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.

Fixed Value

http://electronichealth.se/fhir/StructureDefinition/NLLPeriod

Mappings
  • rim: N/A
Consent.extension:nllInqueryPeriod.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...1
TypePeriod
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Consent.extension:nllInqueryPeriod.value[x].id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.extension:nllInqueryPeriod.value[x].extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.extension:nllInqueryPeriod.value[x].start
DefinitionStart date and time of the proposal period. Calculated by the Swedish eHealth Agency. Not used for input.
Cardinality1...1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.1
  • rim: ./low
  • EHM: Förfrågan giltigt från och med
Consent.extension:nllInqueryPeriod.value[x].end
DefinitionEnd date and time of the proposal period. The consent is terminated automatically unless it is approved before the inquery end time. Calculated by the Swedish eHealth Agency. Not used for input.
Cardinality1...1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

The high 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.2
  • rim: ./high
  • EHM: Förfrågan giltigt till och med
Consent.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, 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.

Invariants
  • 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
Consent.identifier
DefinitionUnique identifier for this copy of the Consent Statement.
Cardinality0...*
TypeIdentifier
SummaryTrue
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.

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

{
  "system": "urn:ietf:rfc:3986",
  "value": "Local eCMS identifier"
}


Mappings
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • rim: .id
Consent.status
DefinitionIndicates the state of this consent.
Cardinality1...1
Typecode
Binding

Indicates the state of the consent.

access-consent-status (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.status
  • w5: FiveWs.status
  • v2: HL7 Table 0498 - Consent Status
  • rim: .statusCode
  • EHM: Samtyckesstatus
Consent.scope
DefinitionAn access consent gives healthcare personnel a possibility to retrieve the specified patient's prescriptions and dispenses depending. Calculated by the Swedish eHealth Agency.
Cardinality1...1
TypeCodeableConcept
Binding

The four anticipated uses for the Consent Resource.

ConsentScopeCodes (extensible)
Must SupportTrue
ModifierTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.scope.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.scope.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.scope.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...*
TypeCoding
Must SupportTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Consent.scope.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.scope.coding.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.scope.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality0...1
Typeuri
Must SupportTrue
SummaryTrue
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 reference to some definition that establishes the system clearly and unambiguously.

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

http://terminology.hl7.org/CodeSystem/consentscope

Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Consent.scope.coding.version
DefinitionThe 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.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Consent.scope.coding.code
DefinitionA 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).
Cardinality0...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

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

patient-privacy

Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • EHM: Tillämpningsområde
Consent.scope.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Consent.scope.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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.scope.text
DefinitionA 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.
Cardinality0...1
Typestring
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Consent.category
DefinitionThe category code INFA is used within the Swedish National Medication List for access consents (sv. åtkomstsamtycke).
Cardinality1...*
TypeCodeableConcept
Binding

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

consent-category-codes (extensible)
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.code
  • w5: FiveWs.class
  • v2: HL7 Table 0497 - Consent Type
  • rim: CNTRCT
Consent.category.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.category.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.category.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...*
TypeCoding
Must SupportTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Consent.category.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.category.coding.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.category.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality0...1
Typeuri
Must SupportTrue
SummaryTrue
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 reference to some definition that establishes the system clearly and unambiguously.

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

http://terminology.hl7.org/CodeSystem/v3-ActCode

Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Consent.category.coding.version
DefinitionThe 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.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Consent.category.coding.code
DefinitionThe category code INFA is used within the Swedish National Medication List for access consents (sv. åtkomstsamtycke).
Cardinality0...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

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

INFA

Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • EHM: Samtyckestyp
Consent.category.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Consent.category.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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
DefinitionA 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.
Cardinality0...1
Typestring
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Consent.patient
DefinitionThe patient to whom this consent applies.
Cardinality0...1
TypeReference(Patient)
Must SupportTrue
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.subject
  • w5: FiveWs.subject[x]
  • rim: Role
  • w5: FiveWs.subject
  • EHM: Patientreferens
Consent.patient.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.patient.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.patient.reference
DefinitionA reference to a patient in the form Patient/
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Consent.patient.type
DefinitionThe 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).
Cardinality0...1
Typeuri
Binding

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

ResourceType (extensible)
SummaryTrue
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 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Consent.patient.identifier
DefinitionAn 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.
Cardinality0...1
TypeIdentifier
SummaryTrue
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).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
Consent.patient.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Consent.dateTime
DefinitionWhen this Consent was issued / created / indexed.
Cardinality0...1
TypedateTime
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.occurrence[x]
  • w5: FiveWs.recorded
  • v2: Field 13/ Consent Decision Date
  • rim: FinancialConsent effectiveTime
Consent.performer
DefinitionEither the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
Cardinality0...*
TypeReference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)
SummaryTrue
Aliasconsentor
Comments

Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.performer
  • w5: FiveWs.actor
  • v2: Field 24/ ConsenterID
Consent.organization
DefinitionThe organization that manages the consent, and the framework within which it is executed.
Cardinality0...*
TypeReference(Organization)
SummaryTrue
Aliascustodian
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.performer
  • w5: FiveWs.witness
Consent.source[x]
DefinitionThe source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
Cardinality0...1
TypeAttachment
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Field 19 Informational Material Supplied Indicator
Consent.policy
DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. Calculated by the Swedish eHealth Agency. Not used for input.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.policy.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.policy.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

Invariants
  • 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
Consent.policy.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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.

Invariants
  • 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
Consent.policy.authority
DefinitionEntity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.
Cardinality0...1
Typeuri
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.policy.uri
DefinitionThe references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
Cardinality0...1
Typeuri
Must SupportTrue
Comments

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

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

https://ehalsomyndigheten.se/nationellalakemedelslistan/policy

Consent.policyRule
DefinitionA reference to the specific base computable regulation or policy.
Cardinality0...1
TypeCodeableConcept
Binding

Regulatory policy examples.

ConsentPolicyRuleCodes (extensible)
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.verification
DefinitionWhether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.
Cardinality0...*
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.verification.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.verification.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

Invariants
  • 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
Consent.verification.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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.

Invariants
  • 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
Consent.verification.verified
DefinitionHas the instruction been verified.
Cardinality1...1
Typeboolean
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.verification.verifiedWith
DefinitionWho verified the instruction (Patient, Relative or other Authorized Person).
Cardinality0...1
TypeReference(Patient | RelatedPerson)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.verification.verificationDate
DefinitionDate verification was collected.
Cardinality0...1
TypedateTime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision
DefinitionAn exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
Cardinality0...1
TypeBackboneElement
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.provision.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

Invariants
  • 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
Consent.provision.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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.

Invariants
  • 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
Consent.provision.type
DefinitionAction to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.
Cardinality0...1
Typecode
Binding

How a rule statement is applied, such as adding additional consent or removing consent.

ConsentProvisionType (required)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision.period
DefinitionThe timeframe in this rule is valid.
Cardinality0...1
TypePeriod
Must SupportTrue
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies.

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision.period.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.provision.period.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.provision.period.start
DefinitionThe start of the period. The boundary is inclusive. The practitioner has access to the patient's information from this time. Calculated by the Swedish eHealth Agency. Not used for input.
Cardinality1...1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.1
  • rim: ./low
  • EHM: Giltigt från och med
Consent.provision.period.end
DefinitionThe 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 practitioner has access to the patient's information until this time. Calculated by the Swedish eHealth Agency. Not used for input.
Cardinality1...1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

The high 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.2
  • rim: ./high
  • EHM: Giltigt till och med
Consent.provision.actor
DefinitionWho or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
Cardinality0...*
TypeBackboneElement
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision.actor.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.provision.actor.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

Invariants
  • 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
Consent.provision.actor.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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.

Invariants
  • 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
Consent.provision.actor.role
DefinitionHow the individual is involved in the resources content that is described in the exception.
Cardinality1...1
TypeCodeableConcept
Binding

How an actor is involved in the consent considerations.

SecurityRoleType (extensible)
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision.actor.role.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.provision.actor.role.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.provision.actor.role.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...*
TypeCoding
Must SupportTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Consent.provision.actor.role.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.provision.actor.role.coding.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.provision.actor.role.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality0...1
Typeuri
Must SupportTrue
SummaryTrue
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 reference to some definition that establishes the system clearly and unambiguously.

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

http://terminology.hl7.org/CodeSystem/v3-RoleCode

Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Consent.provision.actor.role.coding.version
DefinitionThe 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.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Consent.provision.actor.role.coding.code
DefinitionA 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).
Cardinality0...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

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

GRANTEE

Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Consent.provision.actor.role.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Consent.provision.actor.role.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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.actor.role.text
DefinitionA 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.
Cardinality0...1
Typestring
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Consent.provision.actor.reference
DefinitionA reference to the practitioner the consent is intended for, i.e. the person who will have access to the patient's information.
Cardinality1...1
TypeReference(Practitioner)
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • EHM: Samtyckestagare
Consent.provision.actor.reference.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.provision.actor.reference.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.provision.actor.reference.reference
DefinitionA 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.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Consent.provision.actor.reference.type
DefinitionThe 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).
Cardinality0...1
Typeuri
Binding

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

ResourceType (extensible)
Must SupportTrue
SummaryTrue
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 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Consent.provision.actor.reference.identifier
DefinitionAn 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.
Cardinality0...1
TypeIdentifier
SummaryTrue
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).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
Consent.provision.actor.reference.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Consent.provision.action
DefinitionActions controlled by this Rule.
Cardinality0...*
TypeCodeableConcept
Binding

Detailed codes for the consent action.

ConsentActionCodes (example)
SummaryTrue
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'.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision.securityLabel
DefinitionA security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception. Calculated by the Swedish eHealth Agency. Not used for input.
Cardinality0...*
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)
Must SupportTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision.securityLabel.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.provision.securityLabel.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Consent.provision.securityLabel.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality0...1
Typeuri
Must SupportTrue
SummaryTrue
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 reference to some definition that establishes the system clearly and unambiguously.

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

http://terminology.hl7.org/CodeSystem/v3-ActCode

Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Consent.provision.securityLabel.version
DefinitionThe 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.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Consent.provision.securityLabel.code
DefinitionThe precise meaning of IDSCL in the context of Swedish National Medication List is that the patient gives the actor (e.g. a practitioner) access to his/her information in the Swedish National Medication List excluding information having a data lock (represented by a Basic based on the profile NLLDataLock). It is currently not possible to create a consent of locked information.
Cardinality0...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

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

IDSCL

Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • EHM: Informationsklass
Consent.provision.securityLabel.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Consent.provision.securityLabel.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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.purpose
DefinitionThe context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.
Cardinality0...*
TypeCoding
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)
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision.class
DefinitionThe 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.
Cardinality0...*
TypeCoding
Binding

The class (type) of information a consent rule covers.

ConsentContentClass (extensible)
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision.code
DefinitionIf this code is found in an instance, then the rule applies.
Cardinality0...*
TypeCodeableConcept
Binding

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

ConsentContentCodes (example)
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision.dataPeriod
DefinitionClinical or Operational Relevant period of time that bounds the data controlled by this rule.
Cardinality0...1
TypePeriod
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision.data
DefinitionThe resources controlled by this rule if specific resources are referenced.
Cardinality0...*
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Role
Consent.provision.data.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Consent.provision.data.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

Invariants
  • 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
Consent.provision.data.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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.

Invariants
  • 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
Consent.provision.data.meaning
DefinitionHow the resource reference is interpreted when testing consent restrictions.
Cardinality1...1
Typecode
Binding

How a resource reference is interpreted when testing consent restrictions.

ConsentDataMeaning (required)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision.data.reference
DefinitionA reference to a specific resource that defines which resources are covered by this consent.
Cardinality1...1
TypeReference(Resource)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Consent.provision.provision
DefinitionRules which provide exceptions to the base rule or subrules.
Cardinality0...*
Typesee (provision)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
<StructureDefinition xmlns="http://hl7.org/fhir">
    <url value="http://electronichealth.se/fhir/StructureDefinition/NLLAccessConsent" />
    <version value="1.2.0" />
    <name value="NLLAccessConsent" />
    <status value="active" />
    <experimental value="false" />
    <date value="2024-08-28" />
    <publisher value="Swedish eHealth Agency" />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="EHM" />
        <name value="E-h&#228;lsomyndigheten concept" />
    </mapping>
    <mapping>
        <identity value="workflow" />
        <uri value="http://hl7.org/fhir/workflow" />
        <name value="Workflow Pattern" />
    </mapping>
    <mapping>
        <identity value="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <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" />
            <comment value="This profile is intended for Consents of the type access to information within the Swedish National Medication List (sv. &#229;tkomstsamtycke)." />
            <mapping>
                <identity value="EHM" />
                <map value="Registrerat samtycke" />
            </mapping>
        </element>
        <element id="Consent.id">
            <path value="Consent.id" />
            <definition value="UUID identifying the consent" />
            <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation.\nThis id is identified by the URI http://electronichealth.se/identifier/nllconsentid in documentation and external systems." />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Samtyckes-id" />
            </mapping>
        </element>
        <element id="Consent.meta">
            <path value="Consent.meta" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.meta.lastUpdated">
            <path value="Consent.meta.lastUpdated" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.meta.security">
            <path value="Consent.meta.security" />
            <mustSupport value="true" />
            <binding>
                <strength value="extensible" />
                <valueSet value="http://ehalsomyndigheten.se/fhir/ValueSet/security-labels" />
            </binding>
        </element>
        <element id="Consent.meta.security.system">
            <path value="Consent.meta.security.system" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.meta.security.version">
            <path value="Consent.meta.security.version" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.meta.security.code">
            <path value="Consent.meta.security.code" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.extension:nllInqueryPeriod">
            <path value="Consent.extension" />
            <sliceName value="nllInqueryPeriod" />
            <short value="Inquery period" />
            <definition value="An access consent with status proposed must have an inquery period. The period starts when the consent was requested and ends when the consent is terminated unless it is approved by the patient." />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLPeriod" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Consent.extension:nllInqueryPeriod.value[x]">
            <path value="Consent.extension.value[x]" />
        </element>
        <element id="Consent.extension:nllInqueryPeriod.value[x].start">
            <path value="Consent.extension.value[x].start" />
            <short value="Inquery start time" />
            <definition value="Start date and time of the proposal period.\nCalculated by the Swedish eHealth Agency. Not used for input." />
            <min value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="F&#246;rfr&#229;gan giltigt fr&#229;n och med" />
            </mapping>
        </element>
        <element id="Consent.extension:nllInqueryPeriod.value[x].end">
            <path value="Consent.extension.value[x].end" />
            <short value="Inquery end time" />
            <definition value="End date and time of the proposal period. The consent is terminated automatically unless it is approved before the inquery end time.\nCalculated by the Swedish eHealth Agency. Not used for input." />
            <min value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="F&#246;rfr&#229;gan giltigt till och med" />
            </mapping>
        </element>
        <element id="Consent.status">
            <path value="Consent.status" />
            <short value="proposed | active | inactive" />
            <definition value="Indicates the state of this consent." />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://ehalsomyndigheten.se/fhir/ValueSet/access-consent-status" />
            </binding>
            <mapping>
                <identity value="EHM" />
                <map value="Samtyckesstatus" />
            </mapping>
        </element>
        <element id="Consent.scope">
            <path value="Consent.scope" />
            <definition value="An access consent gives healthcare personnel a possibility to retrieve the specified patient&#39;s prescriptions and dispenses depending.\nCalculated by the Swedish eHealth Agency." />
            <mustSupport value="true" />
        </element>
        <element id="Consent.scope.coding">
            <path value="Consent.scope.coding" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.scope.coding.system">
            <path value="Consent.scope.coding.system" />
            <fixedUri value="http://terminology.hl7.org/CodeSystem/consentscope" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.scope.coding.version">
            <path value="Consent.scope.coding.version" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.scope.coding.code">
            <path value="Consent.scope.coding.code" />
            <fixedCode value="patient-privacy" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Till&#228;mpningsomr&#229;de" />
            </mapping>
        </element>
        <element id="Consent.category">
            <path value="Consent.category" />
            <definition value="The category code INFA is used within the Swedish National Medication List for access consents (sv. &#229;tkomstsamtycke)." />
            <mustSupport value="true" />
            <binding>
                <strength value="extensible" />
                <valueSet value="http://ehalsomyndigheten.se/fhir/ValueSet/consent-category-codes" />
            </binding>
        </element>
        <element id="Consent.category.coding">
            <path value="Consent.category.coding" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.category.coding.system">
            <path value="Consent.category.coding.system" />
            <fixedUri value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.category.coding.version">
            <path value="Consent.category.coding.version" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.category.coding.code">
            <path value="Consent.category.coding.code" />
            <definition value="The category code INFA is used within the Swedish National Medication List for access consents (sv. &#229;tkomstsamtycke)." />
            <fixedCode value="INFA" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Samtyckestyp" />
            </mapping>
        </element>
        <element id="Consent.patient">
            <path value="Consent.patient" />
            <definition value="The patient to whom this consent applies." />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Patientreferens" />
            </mapping>
        </element>
        <element id="Consent.patient.reference">
            <path value="Consent.patient.reference" />
            <definition value="A reference to a patient in the form Patient/&lt;uuid&gt;" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.policy">
            <path value="Consent.policy" />
            <definition value="The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.\nCalculated by the Swedish eHealth Agency. Not used for input." />
            <mustSupport value="true" />
        </element>
        <element id="Consent.policy.uri">
            <path value="Consent.policy.uri" />
            <fixedUri value="https://ehalsomyndigheten.se/nationellalakemedelslistan/policy" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision">
            <path value="Consent.provision" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision.period">
            <path value="Consent.provision.period" />
            <comment value="A Period specifies a range of time; the context of use will specify whether the entire range applies.\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration)." />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision.period.start">
            <path value="Consent.provision.period.start" />
            <short value="Start time of the consent." />
            <definition value="The start of the period. The boundary is inclusive. The practitioner has access to the patient&#39;s information from this time.\nCalculated by the Swedish eHealth Agency. Not used for input." />
            <min value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Giltigt fr&#229;n och med" />
            </mapping>
        </element>
        <element id="Consent.provision.period.end">
            <path value="Consent.provision.period.end" />
            <short value="End time of the consent." />
            <definition value="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 practitioner has access to the patient&#39;s information until this time.\nCalculated by the Swedish eHealth Agency. Not used for input." />
            <min value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Giltigt till och med" />
            </mapping>
        </element>
        <element id="Consent.provision.actor">
            <path value="Consent.provision.actor" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision.actor.role">
            <path value="Consent.provision.actor.role" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision.actor.role.coding">
            <path value="Consent.provision.actor.role.coding" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision.actor.role.coding.system">
            <path value="Consent.provision.actor.role.coding.system" />
            <fixedUri value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision.actor.role.coding.version">
            <path value="Consent.provision.actor.role.coding.version" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision.actor.role.coding.code">
            <path value="Consent.provision.actor.role.coding.code" />
            <fixedCode value="GRANTEE" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision.actor.reference">
            <path value="Consent.provision.actor.reference" />
            <definition value="A reference to the practitioner the consent is intended for, i.e. the person who will have access to the patient&#39;s information." />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Samtyckestagare" />
            </mapping>
        </element>
        <element id="Consent.provision.actor.reference.reference">
            <path value="Consent.provision.actor.reference.reference" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision.actor.reference.type">
            <path value="Consent.provision.actor.reference.type" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision.securityLabel">
            <path value="Consent.provision.securityLabel" />
            <definition value="A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.\nCalculated by the Swedish eHealth Agency. Not used for input." />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision.securityLabel.system">
            <path value="Consent.provision.securityLabel.system" />
            <fixedUri value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision.securityLabel.version">
            <path value="Consent.provision.securityLabel.version" />
            <mustSupport value="true" />
        </element>
        <element id="Consent.provision.securityLabel.code">
            <path value="Consent.provision.securityLabel.code" />
            <short value="Classification of information" />
            <definition value="The precise meaning of IDSCL in the context of Swedish National Medication List is that the patient gives the actor (e.g. a practitioner) access to his/her information in the Swedish National Medication List excluding information having a data lock (represented by a Basic based on the profile NLLDataLock). It is currently not possible to create a consent of locked information." />
            <fixedCode value="IDSCL" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Informationsklass" />
            </mapping>
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "url": "http://electronichealth.se/fhir/StructureDefinition/NLLAccessConsent",
    "version": "1.2.0",
    "name": "NLLAccessConsent",
    "status": "active",
    "experimental": false,
    "date": "2024-08-28",
    "publisher": "Swedish eHealth Agency",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "EHM",
            "name": "E-hälsomyndigheten concept"
        },
        {
            "identity": "workflow",
            "uri": "http://hl7.org/fhir/workflow",
            "name": "Workflow Pattern"
        },
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Consent",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Consent",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Consent",
                "path": "Consent",
                "comment": "This profile is intended for Consents of the type access to information within the Swedish National Medication List (sv. åtkomstsamtycke).",
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Registrerat samtycke"
                    }
                ]
            },
            {
                "id": "Consent.id",
                "path": "Consent.id",
                "definition": "UUID identifying the consent",
                "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.\nThis id is identified by the URI http://electronichealth.se/identifier/nllconsentid in documentation and external systems.",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Samtyckes-id"
                    }
                ]
            },
            {
                "id": "Consent.meta",
                "path": "Consent.meta",
                "mustSupport": true
            },
            {
                "id": "Consent.meta.lastUpdated",
                "path": "Consent.meta.lastUpdated",
                "mustSupport": true
            },
            {
                "id": "Consent.meta.security",
                "path": "Consent.meta.security",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/security-labels"
                }
            },
            {
                "id": "Consent.meta.security.system",
                "path": "Consent.meta.security.system",
                "mustSupport": true
            },
            {
                "id": "Consent.meta.security.version",
                "path": "Consent.meta.security.version",
                "mustSupport": true
            },
            {
                "id": "Consent.meta.security.code",
                "path": "Consent.meta.security.code",
                "mustSupport": true
            },
            {
                "id": "Consent.extension:nllInqueryPeriod",
                "path": "Consent.extension",
                "sliceName": "nllInqueryPeriod",
                "short": "Inquery period",
                "definition": "An access consent with status proposed must have an inquery period. The period starts when the consent was requested and ends when the consent is terminated unless it is approved by the patient.",
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://electronichealth.se/fhir/StructureDefinition/NLLPeriod"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Consent.extension:nllInqueryPeriod.value[x]",
                "path": "Consent.extension.value[x]"
            },
            {
                "id": "Consent.extension:nllInqueryPeriod.value[x].start",
                "path": "Consent.extension.value[x].start",
                "short": "Inquery start time",
                "definition": "Start date and time of the proposal period.\nCalculated by the Swedish eHealth Agency. Not used for input.",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Förfrågan giltigt från och med"
                    }
                ]
            },
            {
                "id": "Consent.extension:nllInqueryPeriod.value[x].end",
                "path": "Consent.extension.value[x].end",
                "short": "Inquery end time",
                "definition": "End date and time of the proposal period. The consent is terminated automatically unless it is approved before the inquery end time.\nCalculated by the Swedish eHealth Agency. Not used for input.",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Förfrågan giltigt till och med"
                    }
                ]
            },
            {
                "id": "Consent.status",
                "path": "Consent.status",
                "short": "proposed | active | inactive",
                "definition": "Indicates the state of this consent.",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/access-consent-status"
                },
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Samtyckesstatus"
                    }
                ]
            },
            {
                "id": "Consent.scope",
                "path": "Consent.scope",
                "definition": "An access consent gives healthcare personnel a possibility to retrieve the specified patient's prescriptions and dispenses depending.\nCalculated by the Swedish eHealth Agency.",
                "mustSupport": true
            },
            {
                "id": "Consent.scope.coding",
                "path": "Consent.scope.coding",
                "mustSupport": true
            },
            {
                "id": "Consent.scope.coding.system",
                "path": "Consent.scope.coding.system",
                "fixedUri": "http://terminology.hl7.org/CodeSystem/consentscope",
                "mustSupport": true
            },
            {
                "id": "Consent.scope.coding.version",
                "path": "Consent.scope.coding.version",
                "mustSupport": true
            },
            {
                "id": "Consent.scope.coding.code",
                "path": "Consent.scope.coding.code",
                "fixedCode": "patient-privacy",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Tillämpningsområde"
                    }
                ]
            },
            {
                "id": "Consent.category",
                "path": "Consent.category",
                "definition": "The category code INFA is used within the Swedish National Medication List for access consents (sv. åtkomstsamtycke).",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/consent-category-codes"
                }
            },
            {
                "id": "Consent.category.coding",
                "path": "Consent.category.coding",
                "mustSupport": true
            },
            {
                "id": "Consent.category.coding.system",
                "path": "Consent.category.coding.system",
                "fixedUri": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                "mustSupport": true
            },
            {
                "id": "Consent.category.coding.version",
                "path": "Consent.category.coding.version",
                "mustSupport": true
            },
            {
                "id": "Consent.category.coding.code",
                "path": "Consent.category.coding.code",
                "definition": "The category code INFA is used within the Swedish National Medication List for access consents (sv. åtkomstsamtycke).",
                "fixedCode": "INFA",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Samtyckestyp"
                    }
                ]
            },
            {
                "id": "Consent.patient",
                "path": "Consent.patient",
                "definition": "The patient to whom this consent applies.",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Patientreferens"
                    }
                ]
            },
            {
                "id": "Consent.patient.reference",
                "path": "Consent.patient.reference",
                "definition": "A reference to a patient in the form Patient/<uuid>",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Consent.policy",
                "path": "Consent.policy",
                "definition": "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.\nCalculated by the Swedish eHealth Agency. Not used for input.",
                "mustSupport": true
            },
            {
                "id": "Consent.policy.uri",
                "path": "Consent.policy.uri",
                "fixedUri": "https://ehalsomyndigheten.se/nationellalakemedelslistan/policy",
                "mustSupport": true
            },
            {
                "id": "Consent.provision",
                "path": "Consent.provision",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.period",
                "path": "Consent.provision.period",
                "comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies.\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.period.start",
                "path": "Consent.provision.period.start",
                "short": "Start time of the consent.",
                "definition": "The start of the period. The boundary is inclusive. The practitioner has access to the patient's information from this time.\nCalculated by the Swedish eHealth Agency. Not used for input.",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Giltigt från och med"
                    }
                ]
            },
            {
                "id": "Consent.provision.period.end",
                "path": "Consent.provision.period.end",
                "short": "End time of the consent.",
                "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 practitioner has access to the patient's information until this time.\nCalculated by the Swedish eHealth Agency. Not used for input.",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Giltigt till och med"
                    }
                ]
            },
            {
                "id": "Consent.provision.actor",
                "path": "Consent.provision.actor",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.actor.role",
                "path": "Consent.provision.actor.role",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.actor.role.coding",
                "path": "Consent.provision.actor.role.coding",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.actor.role.coding.system",
                "path": "Consent.provision.actor.role.coding.system",
                "fixedUri": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.actor.role.coding.version",
                "path": "Consent.provision.actor.role.coding.version",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.actor.role.coding.code",
                "path": "Consent.provision.actor.role.coding.code",
                "fixedCode": "GRANTEE",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.actor.reference",
                "path": "Consent.provision.actor.reference",
                "definition": "A reference to the practitioner the consent is intended for, i.e. the person who will have access to the patient's information.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Practitioner"
                        ]
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Samtyckestagare"
                    }
                ]
            },
            {
                "id": "Consent.provision.actor.reference.reference",
                "path": "Consent.provision.actor.reference.reference",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.actor.reference.type",
                "path": "Consent.provision.actor.reference.type",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.securityLabel",
                "path": "Consent.provision.securityLabel",
                "definition": "A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.\nCalculated by the Swedish eHealth Agency. Not used for input.",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.securityLabel.system",
                "path": "Consent.provision.securityLabel.system",
                "fixedUri": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.securityLabel.version",
                "path": "Consent.provision.securityLabel.version",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.securityLabel.code",
                "path": "Consent.provision.securityLabel.code",
                "short": "Classification of information",
                "definition": "The precise meaning of IDSCL in the context of Swedish National Medication List is that the patient gives the actor (e.g. a practitioner) access to his/her information in the Swedish National Medication List excluding information having a data lock (represented by a Basic based on the profile NLLDataLock). It is currently not possible to create a consent of locked information.",
                "fixedCode": "IDSCL",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Informationsklass"
                    }
                ]
            }
        ]
    }
}
Consent..
Consent.id..
Consent.meta..
Consent.meta.lastUpdated..
Consent.meta.security..
Consent.meta.security.system..
Consent.meta.security.version..
Consent.meta.security.code..
Consent.extensionExtension..1
Consent.extension.value[x]..
Consent.extension.value[x].start1..
Consent.extension.value[x].end1..
Consent.status..
Consent.scope..
Consent.scope.coding..
Consent.scope.coding.system..
Consent.scope.coding.version..
Consent.scope.coding.code..
Consent.category..
Consent.category.coding..
Consent.category.coding.system..
Consent.category.coding.version..
Consent.category.coding.code..
Consent.patient..
Consent.patient.reference1..
Consent.policy..
Consent.policy.uri..
Consent.provision..
Consent.provision.period..
Consent.provision.period.start1..
Consent.provision.period.end1..
Consent.provision.actor..
Consent.provision.actor.role..
Consent.provision.actor.role.coding..
Consent.provision.actor.role.coding.system..
Consent.provision.actor.role.coding.version..
Consent.provision.actor.role.coding.code..
Consent.provision.actor.referenceReference(Practitioner)..
Consent.provision.actor.reference.reference..
Consent.provision.actor.reference.type..
Consent.provision.securityLabel..
Consent.provision.securityLabel.system..
Consent.provision.securityLabel.version..
Consent.provision.securityLabel.code..

Details

Description of all elements can be found here, Element descriptions.

Mapping of FHIR element names to Swedish National Medication List names can be found here, Element language mappings.

Statuses

Status Description
proposed The consent is requested by a health care professional
active The consent is accepted by the patient or created directly by the patient
inactive The consent is canceled by the patient or automatically discontinued

Inactive consents are usually not visible.

Category

Status Description
consent-dose-disp The consent is a multi dose dispense consent, i.e. based on NLLMultiDoseDispConsent
INFA The consent is an access consent, i.e. based on NLLAccessConsent

Supported operations

HTTP methods

Operation Supported Comment
Search (GET, POST) yes See below for supported search options.
Insert (POST) yes Create a new access consent. Currently only as a request by a health care professional.
Update (PUT) yes Accept (patient) or terminate (patient, practitioner) a request.
Delete (DEL) no
Operation (GET, POST) no

When interacting with this resource a set of HTTP-headers must be included in the request, see HTTP Header and Authorization.

Query operations

Supported queries

The following query alternatives are available for this resource.

  1. ../Consent/[id]
  2. ../Consent/[id]/_history{/[vid]}
  3. ../Consent?[parameters]
    Parameter chain:
    patient._id=[id]
    &category=INFA
    {&actor.type=[string]}
    {&practitioner.qualification.identifier=[string]}
    {&practitioner.identifier=[string]} (NB! Deprecated. Use practitioner.qualification.identifier )
    {&status=[string]}

Compartment searches

Supported searches on a compartment. This kind of search returns a bundle with the related resources.

  1. ../Consent/[id]/Provenances returns all Provenances related to a specific Consent.

NB! ../Patient/[id]/Consent returns only multi dose dispense Consents.

Include & reverse includes

Supported usage of include and revinclude. This kind of search returns a bundle of both the base resource and the related resources specified in the parameter.

  1. ../Consent?[parameters]&_revinclude=Provenance:target:Consent returns one or more Consents together with their Provenances. The Provenance returned is the one pointing at the returned version of the Consent. See above for a list of valid parameters.

Example: ../Consent?patient._id=<uuid>&category=INFA&_revinclude=Provenance:target:Consent returns all the patient's access consents including one provenance per consent.

For generic information about how to search in FHIR look here.

Search parameters

The table below shows all supported search parameters.

Parameter Description Comment
Consent/[id] A read based on the logical ID (UUID) of a consent
../Consent/<uuid>
_history A vread to get all versions of a consent
../Consent/<uuid>/_history
_history/[vid] A vread to get a specific version of a consent
../Consent/<uuid>/_history/3
patient._id ..&patient._id=<uuid>
category ..&category=INFA Access consent is INFA
Multi dose disp consent is consent-dose-disp
actor.type ..&actor.type=Practitioner Currently only Practitioner is available as a type
practitioner.identifier ..&practitioner.identifier=urn:oid:1.2.752.116.3.1.2|9000027 A practitioner can be identified by a "förskrivarkod" or by "legitimationskod"
Förskrivarkod is identified by urn:oid:1.2.752.116.3.1.2
Legitimationskod is identified by urn:oid:1.2.752.116.3.1.1
If neither of these are provided, the information in the security ticket is used instead. See rule R005 in TA 54 in "Handbok".
status ..&status=Active Active or Proposed