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
NLLAccessConsent (Consent) | I | Consent | |
id | S Σ | 0..1 | string |
meta | S Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | Σ | 0..1 | id |
lastUpdated | S Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | S Σ | 0..* | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uri |
version | S Σ | 0..1 | string |
code | S Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
nllInqueryPeriod | S I | 0..1 | Extension(Period) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 0..1 | ||
valuePeriod | Period | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
start | S Σ I | 1..1 | dateTime |
end | S Σ I | 1..1 | dateTime |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
status | S Σ ?! | 1..1 | codeBinding |
scope | S Σ ?! | 1..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uriFixed Value |
version | S Σ | 0..1 | string |
code | S Σ | 0..1 | codeFixed Value |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
category | S Σ | 1..* | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uriFixed Value |
version | S Σ | 0..1 | string |
code | S Σ | 0..1 | codeFixed Value |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
patient | S Σ | 0..1 | Reference(Patient) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | S Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
dateTime | Σ | 0..1 | dateTime |
performer | Σ | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) |
organization | Σ | 0..* | Reference(Organization) |
source[x] | Σ | 0..1 | |
sourceAttachment | Attachment | ||
sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | ||
policy | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
authority | I | 0..1 | uri |
uri | S I | 0..1 | uriFixed Value |
policyRule | Σ I | 0..1 | CodeableConceptBinding |
verification | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
verified | Σ | 1..1 | boolean |
verifiedWith | 0..1 | Reference(Patient | RelatedPerson) | |
verificationDate | 0..1 | dateTime | |
provision | S Σ | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | Σ | 0..1 | codeBinding |
period | S Σ | 0..1 | Period |
id | 0..1 | string | |
extension | I | 0..* | Extension |
start | S Σ I | 1..1 | dateTime |
end | S Σ I | 1..1 | dateTime |
actor | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
role | S | 1..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uriFixed Value |
version | S Σ | 0..1 | string |
code | S Σ | 0..1 | codeFixed Value |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
reference | S | 1..1 | Reference(Practitioner) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | S Σ I | 0..1 | string |
type | S Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
action | Σ | 0..* | CodeableConcept |
securityLabel | S Σ | 0..* | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uriFixed Value |
version | S Σ | 0..1 | string |
code | S Σ | 0..1 | codeFixed Value |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
purpose | Σ | 0..* | CodingBinding |
class | Σ | 0..* | CodingBinding |
code | Σ | 0..* | CodeableConcept |
dataPeriod | Σ | 0..1 | Period |
data | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
meaning | Σ | 1..1 | codeBinding |
reference | Σ | 1..1 | Reference(Resource) |
provision | 0..* | see (provision) |
Consent | |
Definition | A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. |
Cardinality | 0...* |
Comments | This profile is intended for Consents of the type access to information within the Swedish National Medication List (sv. åtkomstsamtycke). |
Invariants |
|
Mappings |
|
Consent.id | |
Definition | UUID identifying the consent |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Consent.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Must Support | True |
Summary | True |
Invariants |
|
Consent.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.meta.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Cardinality | 0...1 |
Type | id |
Summary | True |
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 |
|
Consent.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
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 |
|
Consent.meta.source | |
Definition | A 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. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
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 |
|
Consent.meta.profile | |
Definition | A 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). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
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 |
|
Consent.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Must Support | True |
Summary | True |
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 |
|
Consent.meta.security.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.meta.security.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.meta.security.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Consent.meta.security.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Consent.meta.security.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Consent.meta.security.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Consent.meta.security.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Consent.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Cardinality | 0...* |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
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 |
|
Consent.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Consent.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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 |
|
Consent.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have 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 |
|
Mappings |
|
Consent.contained | |
Definition | These 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. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Consent.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.extension:nllInqueryPeriod | |
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. |
Cardinality | 0...1 |
Type | Extension(Period) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Consent.extension:nllInqueryPeriod.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.extension:nllInqueryPeriod.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.extension:nllInqueryPeriod.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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 |
|
Consent.extension:nllInqueryPeriod.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...1 |
Type | Period |
Invariants |
|
Mappings |
|
Consent.extension:nllInqueryPeriod.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.extension:nllInqueryPeriod.value[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.extension:nllInqueryPeriod.value[x].start | |
Definition | Start date and time of the proposal period. Calculated by the Swedish eHealth Agency. Not used for input. |
Cardinality | 1...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Invariants |
|
Mappings |
|
Consent.extension:nllInqueryPeriod.value[x].end | |
Definition | End 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. |
Cardinality | 1...1 |
Type | dateTime |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Consent.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Consent.identifier | |
Definition | Unique identifier for this copy of the Consent Statement. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Comments | This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same. |
Invariants |
|
Examples | General { "system": "urn:ietf:rfc:3986", "value": "Local eCMS identifier" } |
Mappings |
|
Consent.status | |
Definition | Indicates the state of this consent. |
Cardinality | 1...1 |
Type | code |
Binding | Indicates the state of the consent. |
Must Support | True |
Modifier | True |
Summary | True |
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 |
|
Mappings |
|
Consent.scope | |
Definition | An access consent gives healthcare personnel a possibility to retrieve the specified patient's prescriptions and dispenses depending. Calculated by the Swedish eHealth Agency. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | The four anticipated uses for the Consent Resource. |
Must Support | True |
Modifier | True |
Summary | True |
Invariants |
|
Consent.scope.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.scope.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.scope.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Consent.scope.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.scope.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.scope.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://terminology.hl7.org/CodeSystem/consentscope |
Mappings |
|
Consent.scope.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Consent.scope.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Fixed Value | patient-privacy |
Mappings |
|
Consent.scope.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Consent.scope.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Consent.scope.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Consent.category | |
Definition | The category code INFA is used within the Swedish National Medication List for access consents (sv. åtkomstsamtycke). |
Cardinality | 1...* |
Type | CodeableConcept |
Binding | A classification of the type of consents found in a consent statement. |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Consent.category.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.category.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.category.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Consent.category.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.category.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.category.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://terminology.hl7.org/CodeSystem/v3-ActCode |
Mappings |
|
Consent.category.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Consent.category.coding.code | |
Definition | The category code INFA is used within the Swedish National Medication List for access consents (sv. åtkomstsamtycke). |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Fixed Value | INFA |
Mappings |
|
Consent.category.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Consent.category.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Consent.category.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Consent.patient | |
Definition | The patient to whom this consent applies. |
Cardinality | 0...1 |
Type | Reference(Patient) |
Must Support | True |
Summary | True |
Comments | Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person. |
Invariants |
|
Mappings |
|
Consent.patient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.patient.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.patient.reference | |
Definition | A reference to a patient in the form Patient/ |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Consent.patient.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a 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 |
|
Mappings |
|
Consent.patient.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Consent.patient.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Consent.dateTime | |
Definition | When this Consent was issued / created / indexed. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Comments | This is not the time of the original consent, but the time that this statement was made or derived. |
Invariants |
|
Mappings |
|
Consent.performer | |
Definition | Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions. |
Cardinality | 0...* |
Type | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) |
Summary | True |
Alias | consentor |
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 |
|
Mappings |
|
Consent.organization | |
Definition | The organization that manages the consent, and the framework within which it is executed. |
Cardinality | 0...* |
Type | Reference(Organization) |
Summary | True |
Alias | custodian |
Invariants |
|
Mappings |
|
Consent.source[x] | |
Definition | The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document. |
Cardinality | 0...1 |
Type | Attachment |
Summary | True |
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 |
|
Mappings |
|
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. Calculated by the Swedish eHealth Agency. Not used for input. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Invariants |
|
Consent.policy.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.policy.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Consent.policy.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Consent.policy.authority | |
Definition | Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives. |
Cardinality | 0...1 |
Type | uri |
Invariants |
|
Consent.policy.uri | |
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. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Comments | This element is for discoverability / documentation and does not modify or qualify the policy rules. |
Invariants |
|
Fixed Value | https://ehalsomyndigheten.se/nationellalakemedelslistan/policy |
Consent.policyRule | |
Definition | A reference to the specific base computable regulation or policy. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Regulatory policy examples. |
Summary | True |
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 |
|
Consent.verification | |
Definition | Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Invariants |
|
Consent.verification.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.verification.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Consent.verification.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Consent.verification.verified | |
Definition | Has the instruction been verified. |
Cardinality | 1...1 |
Type | boolean |
Summary | True |
Invariants |
|
Consent.verification.verifiedWith | |
Definition | Who verified the instruction (Patient, Relative or other Authorized Person). |
Cardinality | 0...1 |
Type | Reference(Patient | RelatedPerson) |
Invariants |
|
Consent.verification.verificationDate | |
Definition | Date verification was collected. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Consent.provision | |
Definition | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. |
Cardinality | 0...1 |
Type | BackboneElement |
Must Support | True |
Summary | True |
Invariants |
|
Consent.provision.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.provision.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Consent.provision.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Consent.provision.type | |
Definition | Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules. |
Cardinality | 0...1 |
Type | code |
Binding | How a rule statement is applied, such as adding additional consent or removing consent. |
Summary | True |
Invariants |
|
Consent.provision.period | |
Definition | The timeframe in this rule is valid. |
Cardinality | 0...1 |
Type | Period |
Must Support | True |
Summary | True |
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 |
|
Consent.provision.period.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.provision.period.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.provision.period.start | |
Definition | The 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. |
Cardinality | 1...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Invariants |
|
Mappings |
|
Consent.provision.period.end | |
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. Calculated by the Swedish eHealth Agency. Not used for input. |
Cardinality | 1...1 |
Type | dateTime |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Consent.provision.actor | |
Definition | Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Invariants |
|
Consent.provision.actor.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.provision.actor.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Consent.provision.actor.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Consent.provision.actor.role | |
Definition | How the individual is involved in the resources content that is described in the exception. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | How an actor is involved in the consent considerations. |
Must Support | True |
Invariants |
|
Consent.provision.actor.role.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.provision.actor.role.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.provision.actor.role.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Consent.provision.actor.role.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.provision.actor.role.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.provision.actor.role.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://terminology.hl7.org/CodeSystem/v3-RoleCode |
Mappings |
|
Consent.provision.actor.role.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Consent.provision.actor.role.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Fixed Value | GRANTEE |
Mappings |
|
Consent.provision.actor.role.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Consent.provision.actor.role.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Consent.provision.actor.role.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 1...1 |
Type | Reference(Practitioner) |
Must Support | True |
Invariants |
|
Mappings |
|
Consent.provision.actor.reference.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.provision.actor.reference.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.provision.actor.reference.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Consent.provision.actor.reference.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Must Support | True |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a 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 |
|
Mappings |
|
Consent.provision.actor.reference.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Consent.provision.actor.reference.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Consent.provision.action | |
Definition | Actions controlled by this Rule. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Detailed codes for the consent action. |
Summary | True |
Comments | Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'. |
Invariants |
|
Consent.provision.securityLabel | |
Definition | A 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. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Must Support | True |
Summary | True |
Comments | If the consent specifies a security label of "R" then it applies to all resources that are labeled "R" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict. |
Invariants |
|
Consent.provision.securityLabel.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.provision.securityLabel.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Consent.provision.securityLabel.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://terminology.hl7.org/CodeSystem/v3-ActCode |
Mappings |
|
Consent.provision.securityLabel.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Consent.provision.securityLabel.code | |
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. |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Fixed Value | IDSCL |
Mappings |
|
Consent.provision.securityLabel.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Consent.provision.securityLabel.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Consent.provision.purpose | |
Definition | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule. |
Cardinality | 0...* |
Type | Coding |
Binding | What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. |
Summary | True |
Comments | When the purpose of use tag is on the data, access request purpose of use shall not conflict. |
Invariants |
|
Consent.provision.class | |
Definition | The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. |
Cardinality | 0...* |
Type | Coding |
Binding | The class (type) of information a consent rule covers. |
Summary | True |
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 |
|
Consent.provision.code | |
Definition | If this code is found in an instance, then the rule applies. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | If this code is found in an instance, then the exception applies. |
Summary | True |
Comments | Typical use of this is a Document code with class = CDA. |
Invariants |
|
Consent.provision.dataPeriod | |
Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this rule. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement. |
Invariants |
|
Consent.provision.data | |
Definition | The resources controlled by this rule if specific resources are referenced. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
Consent.provision.data.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Consent.provision.data.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Consent.provision.data.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Consent.provision.data.meaning | |
Definition | How the resource reference is interpreted when testing consent restrictions. |
Cardinality | 1...1 |
Type | code |
Binding | How a resource reference is interpreted when testing consent restrictions. |
Summary | True |
Invariants |
|
Consent.provision.data.reference | |
Definition | A reference to a specific resource that defines which resources are covered by this consent. |
Cardinality | 1...1 |
Type | Reference(Resource) |
Summary | True |
Invariants |
|
Consent.provision.provision | |
Definition | Rules which provide exceptions to the base rule or subrules. |
Cardinality | 0...* |
Type | see (provision) |
Invariants |
|
<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ä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. å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örfrågan giltigt frå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örfrå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'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ämpningsområ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. å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. å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/<uuid>" /> <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'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å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'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'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.extension | Extension | ..1 |
Consent.extension.value[x] | .. | |
Consent.extension.value[x].start | 1.. | |
Consent.extension.value[x].end | 1.. | |
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.reference | 1.. | |
Consent.policy | .. | |
Consent.policy.uri | .. | |
Consent.provision | .. | |
Consent.provision.period | .. | |
Consent.provision.period.start | 1.. | |
Consent.provision.period.end | 1.. | |
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.reference | Reference(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.
../Consent/[id]
../Consent/[id]/_history{/[vid]}
../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.
../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.
../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 |