Common FHIR profile vendor collaboration

1.0.0 - release Sweden flag

This page is part of the Common FHIR profile vendor collaboration (v1.0.0: Release) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: ConsentSJF

Official URL: https://commonprofiles.care/fhir/StructureDefinition/ConsentSJF Version: 1.0.0
Active as of 2023-03-17 Computable Name: ConsentSJF

Profile to represent a consent to shared record keeping in between care providers in Sweden.

To enable creating consents, evaluation and exchange of already stored consents

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... identifier 0..1IdentifierIdentifier for this record (external references)
... scope
.... coding 1..1CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
Binding: ConsentScopeCodes (extensible): Consent Scope Codes

..... code 1..1codeSymbol in syntax defined by the system
Fixed Value: patient-privacy
... category 1..1CodeableConceptClassification of the consent statement - for indexing/retrieval
.... coding 1..1CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1stringVersion of the system - if relevant
Fixed Value: http://snomed.info/sct/45991000052106/version/20220531
..... code 1..1codeSymbol in syntax defined by the system
Fixed Value: 70831000052108
... dateTime 1..1dateTimeWhen this Consent was created or indexed
... policy 1..1BackboneElementPolicies covered by this consent
.... uri 1..1uriSpecific policy covered by this consent
Fixed Value: https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/patientdatalag-2008355_sfs-2008-355
... provision 1..1BackboneElementConstraints to the base Consent.policyRule
.... type 1..1codedeny | permit
Fixed Value: permit
.... period 1..1PeriodTimeframe for this rule
.... Slices for actor 2..3BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Closed by value:role.coding.code
..... Slices for actor:grantor S1..1BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Closed by value:reference.identifier.system
...... actor:grantor:All Slices Content/Rules for all slices
....... role
........ coding
......... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
......... code 1..1codeSymbol in syntax defined by the system
Fixed Value: GRANTOR
....... reference 1..1Reference(Patient | RelatedPerson)Resource for the actor (or group, by role)
...... actor:grantor/personnummer 0..1BackboneElementWho|what controlled by this rule (or group, by role)
....... reference
........ identifier 1..1IdentifierLogical reference, when literal reference is not known
......... system 0..1uriThe namespace for the identifier value
Fixed Value: http://electronichealth.se/identifier/personnummer
......... value 1..1stringThe value that is unique
...... actor:grantor/samordningsnummer 0..1BackboneElementWho|what controlled by this rule (or group, by role)
....... reference
........ identifier 1..1IdentifierLogical reference, when literal reference is not known
......... system 0..1uriThe namespace for the identifier value
Fixed Value: http://electronichealth.se/identifier/samordningsnummer
......... value 1..1stringThe value that is unique
...... actor:grantee S1..1BackboneElementWho|what controlled by this rule (or group, by role)
....... role
........ coding
......... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
......... code 1..1codeSymbol in syntax defined by the system
Fixed Value: GRANTEE
....... reference
........ identifier 1..1IdentifierLogical reference, when literal reference is not known
......... system 1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
......... value 1..1stringThe value that is unique
...... actor:primaryauthor S0..1BackboneElementWho|what controlled by this rule (or group, by role)
....... role
........ coding
......... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/contractsignertypecodes
......... code 1..1codeSymbol in syntax defined by the system
Fixed Value: PRIMAUTH
....... reference 1..1Reference(PractitionerRole)Resource for the actor (or group, by role)
........ identifier 1..1IdentifierLogical reference, when literal reference is not known
......... system 1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:1.2.752.29.4.19
......... value 1..1stringThe value that is unique

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Consent.scope.coding.systemextensibleConsentScopeCodes
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierIdentifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... scope ?!Σ1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.

.... coding Σ1..1CodingCode defined by a terminology system
..... system Σ1..1uriIdentity of the terminology system
Binding: ConsentScopeCodes (extensible): Consent Scope Codes

..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: patient-privacy
... category Σ1..1CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.


.... coding Σ1..1CodingCode defined by a terminology system
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ0..1stringVersion of the system - if relevant
Fixed Value: http://snomed.info/sct/45991000052106/version/20220531
..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 70831000052108
... patient Σ1..1Reference(PatientSEVendorLite)Who the consent applies to
... dateTime Σ1..1dateTimeWhen this Consent was created or indexed
... policy 1..1BackboneElementPolicies covered by this consent
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uri C1..1uriSpecific policy covered by this consent
Fixed Value: https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/patientdatalag-2008355_sfs-2008-355
... provision Σ1..1BackboneElementConstraints to the base Consent.policyRule
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.


Fixed Value: permit
.... period Σ1..1PeriodTimeframe for this rule
.... Slices for actor 2..3BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Closed by value:role.coding.code
..... actor:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
..... actor:grantor S1..1BackboneElementWho|what controlled by this rule (or group, by role)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Patient | RelatedPerson)Resource for the actor (or group, by role)
..... actor:grantor/personnummer S0..1BackboneElementWho|what controlled by this rule (or group, by role)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ system Σ0..1uriThe namespace for the identifier value
Fixed Value: http://electronichealth.se/identifier/personnummer
........ value Σ1..1stringThe value that is unique
Example General: 123456
..... actor:grantor/samordningsnummer S0..1BackboneElementWho|what controlled by this rule (or group, by role)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ system Σ0..1uriThe namespace for the identifier value
Fixed Value: http://electronichealth.se/identifier/samordningsnummer
........ value Σ1..1stringThe value that is unique
Example General: 123456
..... actor:grantee S1..1BackboneElementWho|what controlled by this rule (or group, by role)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
........ value Σ1..1stringThe value that is unique
Example General: 123456
..... actor:primaryauthor S0..1BackboneElementWho|what controlled by this rule (or group, by role)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(PractitionerRole)Resource for the actor (or group, by role)
....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:1.2.752.29.4.19
........ value Σ1..1stringThe value that is unique
Example General: 123456

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Consent.statusrequiredConsentState
Consent.scopeextensibleConsentScopeCodes
Consent.scope.coding.systemextensibleConsentScopeCodes
Consent.categoryextensibleConsentCategoryCodes
Consent.provision.typerequiredFixed Value: permit
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actor:grantor.roleextensibleSecurityRoleType
Consent.provision.actor:grantor/personnummer.roleextensibleSecurityRoleType
Consent.provision.actor:grantor/personnummer.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:grantor/samordningsnummer.roleextensibleSecurityRoleType
Consent.provision.actor:grantor/samordningsnummer.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:grantee.roleextensibleSecurityRoleType
Consent.provision.actor:grantee.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:primaryauthor.roleextensibleSecurityRoleType
Consent.provision.actor:primaryauthor.reference.identifier.userequiredIdentifierUse

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorConsentIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorConsentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConsentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ppc-1errorConsentEither a Policy or PolicyRule
: policy.exists() or policyRule.exists()
ppc-2errorConsentIF Scope=privacy, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3errorConsentIF Scope=research, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4errorConsentIF Scope=adr, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5errorConsentIF Scope=treatment, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierIdentifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!Σ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.

... scope ?!Σ1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..1CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Binding: ConsentScopeCodes (extensible): Consent Scope Codes

..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: patient-privacy
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... category Σ1..1CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..1CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ0..1stringVersion of the system - if relevant
Fixed Value: http://snomed.info/sct/45991000052106/version/20220531
..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 70831000052108
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... patient Σ1..1Reference(PatientSEVendorLite)Who the consent applies to
... dateTime Σ1..1dateTimeWhen this Consent was created or indexed
... performer Σ0..*Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Who is agreeing to the policy and rules
... organization Σ0..*Reference(Organization)Custodian of the consent
... source[x] Σ0..1Source from which this consent is taken
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy 1..1BackboneElementPolicies covered by this consent
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... authority C0..1uriEnforcement source for policy
.... uri C1..1uriSpecific policy covered by this consent
Fixed Value: https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/patientdatalag-2008355_sfs-2008-355
... policyRule ΣC0..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... verification Σ0..*BackboneElementConsent Verified by patient or family
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... verified Σ1..1booleanHas been verified
.... verifiedWith 0..1Reference(Patient | RelatedPerson)Person who verified
.... verificationDate 0..1dateTimeWhen consent verified
... provision Σ1..1BackboneElementConstraints to the base Consent.policyRule
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.


Fixed Value: permit
.... period Σ1..1PeriodTimeframe for this rule
.... Slices for actor 2..3BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Closed by value:role.coding.code
..... actor:All Slices Content/Rules for all slices
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
..... actor:grantor S1..1BackboneElementWho|what controlled by this rule (or group, by role)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ0..*CodingCode defined by a terminology system
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: GRANTOR
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... reference 1..1Reference(Patient | RelatedPerson)Resource for the actor (or group, by role)
..... actor:grantor/personnummer S0..1BackboneElementWho|what controlled by this rule (or group, by role)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

........ system Σ0..1uriThe namespace for the identifier value
Fixed Value: http://electronichealth.se/identifier/personnummer
........ value Σ1..1stringThe value that is unique
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
....... display Σ0..1stringText alternative for the resource
..... actor:grantor/samordningsnummer S0..1BackboneElementWho|what controlled by this rule (or group, by role)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

........ system Σ0..1uriThe namespace for the identifier value
Fixed Value: http://electronichealth.se/identifier/samordningsnummer
........ value Σ1..1stringThe value that is unique
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
....... display Σ0..1stringText alternative for the resource
..... actor:grantee S1..1BackboneElementWho|what controlled by this rule (or group, by role)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ0..*CodingCode defined by a terminology system
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: GRANTEE
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

........ system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
........ value Σ1..1stringThe value that is unique
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
....... display Σ0..1stringText alternative for the resource
..... actor:primaryauthor S0..1BackboneElementWho|what controlled by this rule (or group, by role)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ0..*CodingCode defined by a terminology system
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/contractsignertypecodes
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: PRIMAUTH
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... reference 1..1Reference(PractitionerRole)Resource for the actor (or group, by role)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

........ system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:1.2.752.29.4.19
........ value Σ1..1stringThe value that is unique
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
....... display Σ0..1stringText alternative for the resource
.... action Σ0..*CodeableConceptActions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.


.... securityLabel Σ0..*CodingSecurity Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... purpose Σ0..*CodingContext of activities covered by this rule
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.


.... class Σ0..*Codinge.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.


.... code Σ0..*CodeableConcepte.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.


.... dataPeriod Σ0..1PeriodTimeframe for data controlled by this rule
.... data Σ0..*BackboneElementData controlled by this rule
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... meaning Σ1..1codeinstance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.

..... reference Σ1..1Reference(Resource)The actual data reference
.... provision 0..*See provision (Consent)Nested Exception Rules

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Consent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Consent.statusrequiredConsentState
Consent.scopeextensibleConsentScopeCodes
Consent.scope.coding.systemextensibleConsentScopeCodes
Consent.categoryextensibleConsentCategoryCodes
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.typerequiredFixed Value: permit
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actor:grantor.roleextensibleSecurityRoleType
Consent.provision.actor:grantor/personnummer.roleextensibleSecurityRoleType
Consent.provision.actor:grantor/personnummer.reference.typeextensibleResourceType
Consent.provision.actor:grantor/personnummer.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:grantor/personnummer.reference.identifier.typeextensibleIdentifier Type Codes
Consent.provision.actor:grantor/samordningsnummer.roleextensibleSecurityRoleType
Consent.provision.actor:grantor/samordningsnummer.reference.typeextensibleResourceType
Consent.provision.actor:grantor/samordningsnummer.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:grantor/samordningsnummer.reference.identifier.typeextensibleIdentifier Type Codes
Consent.provision.actor:grantee.roleextensibleSecurityRoleType
Consent.provision.actor:grantee.reference.typeextensibleResourceType
Consent.provision.actor:grantee.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:grantee.reference.identifier.typeextensibleIdentifier Type Codes
Consent.provision.actor:primaryauthor.roleextensibleSecurityRoleType
Consent.provision.actor:primaryauthor.reference.typeextensibleResourceType
Consent.provision.actor:primaryauthor.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:primaryauthor.reference.identifier.typeextensibleIdentifier Type Codes
Consent.provision.actionexampleConsentActionCodes
Consent.provision.securityLabelextensibleAll Security Labels
Consent.provision.purposeextensiblePurposeOfUse
Consent.provision.classextensibleConsentContentClass
Consent.provision.codeexampleConsentContentCodes (a valid code from LOINC)
Consent.provision.data.meaningrequiredConsentDataMeaning

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Consent

Summary

Mandatory: 18 elements (10 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 15 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Consent.provision.actor is sliced based on the value of value:role.coding.code (Closed)
  • The element Consent.provision.actor is sliced based on the value of value:reference.identifier.system (Closed)

Differential View

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... identifier 0..1IdentifierIdentifier for this record (external references)
... scope
.... coding 1..1CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
Binding: ConsentScopeCodes (extensible): Consent Scope Codes

..... code 1..1codeSymbol in syntax defined by the system
Fixed Value: patient-privacy
... category 1..1CodeableConceptClassification of the consent statement - for indexing/retrieval
.... coding 1..1CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1stringVersion of the system - if relevant
Fixed Value: http://snomed.info/sct/45991000052106/version/20220531
..... code 1..1codeSymbol in syntax defined by the system
Fixed Value: 70831000052108
... dateTime 1..1dateTimeWhen this Consent was created or indexed
... policy 1..1BackboneElementPolicies covered by this consent
.... uri 1..1uriSpecific policy covered by this consent
Fixed Value: https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/patientdatalag-2008355_sfs-2008-355
... provision 1..1BackboneElementConstraints to the base Consent.policyRule
.... type 1..1codedeny | permit
Fixed Value: permit
.... period 1..1PeriodTimeframe for this rule
.... Slices for actor 2..3BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Closed by value:role.coding.code
..... Slices for actor:grantor S1..1BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Closed by value:reference.identifier.system
...... actor:grantor:All Slices Content/Rules for all slices
....... role
........ coding
......... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
......... code 1..1codeSymbol in syntax defined by the system
Fixed Value: GRANTOR
....... reference 1..1Reference(Patient | RelatedPerson)Resource for the actor (or group, by role)
...... actor:grantor/personnummer 0..1BackboneElementWho|what controlled by this rule (or group, by role)
....... reference
........ identifier 1..1IdentifierLogical reference, when literal reference is not known
......... system 0..1uriThe namespace for the identifier value
Fixed Value: http://electronichealth.se/identifier/personnummer
......... value 1..1stringThe value that is unique
...... actor:grantor/samordningsnummer 0..1BackboneElementWho|what controlled by this rule (or group, by role)
....... reference
........ identifier 1..1IdentifierLogical reference, when literal reference is not known
......... system 0..1uriThe namespace for the identifier value
Fixed Value: http://electronichealth.se/identifier/samordningsnummer
......... value 1..1stringThe value that is unique
...... actor:grantee S1..1BackboneElementWho|what controlled by this rule (or group, by role)
....... role
........ coding
......... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
......... code 1..1codeSymbol in syntax defined by the system
Fixed Value: GRANTEE
....... reference
........ identifier 1..1IdentifierLogical reference, when literal reference is not known
......... system 1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
......... value 1..1stringThe value that is unique
...... actor:primaryauthor S0..1BackboneElementWho|what controlled by this rule (or group, by role)
....... role
........ coding
......... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/contractsignertypecodes
......... code 1..1codeSymbol in syntax defined by the system
Fixed Value: PRIMAUTH
....... reference 1..1Reference(PractitionerRole)Resource for the actor (or group, by role)
........ identifier 1..1IdentifierLogical reference, when literal reference is not known
......... system 1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:1.2.752.29.4.19
......... value 1..1stringThe value that is unique

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Consent.scope.coding.systemextensibleConsentScopeCodes

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierIdentifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... scope ?!Σ1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.

.... coding Σ1..1CodingCode defined by a terminology system
..... system Σ1..1uriIdentity of the terminology system
Binding: ConsentScopeCodes (extensible): Consent Scope Codes

..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: patient-privacy
... category Σ1..1CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.


.... coding Σ1..1CodingCode defined by a terminology system
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ0..1stringVersion of the system - if relevant
Fixed Value: http://snomed.info/sct/45991000052106/version/20220531
..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 70831000052108
... patient Σ1..1Reference(PatientSEVendorLite)Who the consent applies to
... dateTime Σ1..1dateTimeWhen this Consent was created or indexed
... policy 1..1BackboneElementPolicies covered by this consent
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uri C1..1uriSpecific policy covered by this consent
Fixed Value: https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/patientdatalag-2008355_sfs-2008-355
... provision Σ1..1BackboneElementConstraints to the base Consent.policyRule
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.


Fixed Value: permit
.... period Σ1..1PeriodTimeframe for this rule
.... Slices for actor 2..3BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Closed by value:role.coding.code
..... actor:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
..... actor:grantor S1..1BackboneElementWho|what controlled by this rule (or group, by role)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Patient | RelatedPerson)Resource for the actor (or group, by role)
..... actor:grantor/personnummer S0..1BackboneElementWho|what controlled by this rule (or group, by role)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ system Σ0..1uriThe namespace for the identifier value
Fixed Value: http://electronichealth.se/identifier/personnummer
........ value Σ1..1stringThe value that is unique
Example General: 123456
..... actor:grantor/samordningsnummer S0..1BackboneElementWho|what controlled by this rule (or group, by role)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ system Σ0..1uriThe namespace for the identifier value
Fixed Value: http://electronichealth.se/identifier/samordningsnummer
........ value Σ1..1stringThe value that is unique
Example General: 123456
..... actor:grantee S1..1BackboneElementWho|what controlled by this rule (or group, by role)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
........ value Σ1..1stringThe value that is unique
Example General: 123456
..... actor:primaryauthor S0..1BackboneElementWho|what controlled by this rule (or group, by role)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(PractitionerRole)Resource for the actor (or group, by role)
....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:1.2.752.29.4.19
........ value Σ1..1stringThe value that is unique
Example General: 123456

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Consent.statusrequiredConsentState
Consent.scopeextensibleConsentScopeCodes
Consent.scope.coding.systemextensibleConsentScopeCodes
Consent.categoryextensibleConsentCategoryCodes
Consent.provision.typerequiredFixed Value: permit
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actor:grantor.roleextensibleSecurityRoleType
Consent.provision.actor:grantor/personnummer.roleextensibleSecurityRoleType
Consent.provision.actor:grantor/personnummer.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:grantor/samordningsnummer.roleextensibleSecurityRoleType
Consent.provision.actor:grantor/samordningsnummer.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:grantee.roleextensibleSecurityRoleType
Consent.provision.actor:grantee.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:primaryauthor.roleextensibleSecurityRoleType
Consent.provision.actor:primaryauthor.reference.identifier.userequiredIdentifierUse

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorConsentIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorConsentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConsentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ppc-1errorConsentEither a Policy or PolicyRule
: policy.exists() or policyRule.exists()
ppc-2errorConsentIF Scope=privacy, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3errorConsentIF Scope=research, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4errorConsentIF Scope=adr, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5errorConsentIF Scope=treatment, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierIdentifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!Σ1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.

... scope ?!Σ1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..1CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Binding: ConsentScopeCodes (extensible): Consent Scope Codes

..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: patient-privacy
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... category Σ1..1CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..1CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ0..1stringVersion of the system - if relevant
Fixed Value: http://snomed.info/sct/45991000052106/version/20220531
..... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 70831000052108
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... patient Σ1..1Reference(PatientSEVendorLite)Who the consent applies to
... dateTime Σ1..1dateTimeWhen this Consent was created or indexed
... performer Σ0..*Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Who is agreeing to the policy and rules
... organization Σ0..*Reference(Organization)Custodian of the consent
... source[x] Σ0..1Source from which this consent is taken
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy 1..1BackboneElementPolicies covered by this consent
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... authority C0..1uriEnforcement source for policy
.... uri C1..1uriSpecific policy covered by this consent
Fixed Value: https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/patientdatalag-2008355_sfs-2008-355
... policyRule ΣC0..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... verification Σ0..*BackboneElementConsent Verified by patient or family
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... verified Σ1..1booleanHas been verified
.... verifiedWith 0..1Reference(Patient | RelatedPerson)Person who verified
.... verificationDate 0..1dateTimeWhen consent verified
... provision Σ1..1BackboneElementConstraints to the base Consent.policyRule
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.


Fixed Value: permit
.... period Σ1..1PeriodTimeframe for this rule
.... Slices for actor 2..3BackboneElementWho|what controlled by this rule (or group, by role)
Slice: Unordered, Closed by value:role.coding.code
..... actor:All Slices Content/Rules for all slices
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
..... actor:grantor S1..1BackboneElementWho|what controlled by this rule (or group, by role)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ0..*CodingCode defined by a terminology system
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: GRANTOR
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... reference 1..1Reference(Patient | RelatedPerson)Resource for the actor (or group, by role)
..... actor:grantor/personnummer S0..1BackboneElementWho|what controlled by this rule (or group, by role)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

........ system Σ0..1uriThe namespace for the identifier value
Fixed Value: http://electronichealth.se/identifier/personnummer
........ value Σ1..1stringThe value that is unique
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
....... display Σ0..1stringText alternative for the resource
..... actor:grantor/samordningsnummer S0..1BackboneElementWho|what controlled by this rule (or group, by role)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

........ system Σ0..1uriThe namespace for the identifier value
Fixed Value: http://electronichealth.se/identifier/samordningsnummer
........ value Σ1..1stringThe value that is unique
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
....... display Σ0..1stringText alternative for the resource
..... actor:grantee S1..1BackboneElementWho|what controlled by this rule (or group, by role)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ0..*CodingCode defined by a terminology system
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: GRANTEE
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... reference 1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

........ system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
........ value Σ1..1stringThe value that is unique
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
....... display Σ0..1stringText alternative for the resource
..... actor:primaryauthor S0..1BackboneElementWho|what controlled by this rule (or group, by role)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ0..*CodingCode defined by a terminology system
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/contractsignertypecodes
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: PRIMAUTH
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... text Σ0..1stringPlain text representation of the concept
...... reference 1..1Reference(PractitionerRole)Resource for the actor (or group, by role)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

........ type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

........ system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:1.2.752.29.4.19
........ value Σ1..1stringThe value that is unique
Example General: 123456
........ period Σ0..1PeriodTime period when id is/was valid for use
........ assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
....... display Σ0..1stringText alternative for the resource
.... action Σ0..*CodeableConceptActions controlled by this rule
Binding: ConsentActionCodes (example): Detailed codes for the consent action.


.... securityLabel Σ0..*CodingSecurity Labels that define affected resources
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... purpose Σ0..*CodingContext of activities covered by this rule
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.


.... class Σ0..*Codinge.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.


.... code Σ0..*CodeableConcepte.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.


.... dataPeriod Σ0..1PeriodTimeframe for data controlled by this rule
.... data Σ0..*BackboneElementData controlled by this rule
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... meaning Σ1..1codeinstance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.

..... reference Σ1..1Reference(Resource)The actual data reference
.... provision 0..*See provision (Consent)Nested Exception Rules

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Consent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Consent.statusrequiredConsentState
Consent.scopeextensibleConsentScopeCodes
Consent.scope.coding.systemextensibleConsentScopeCodes
Consent.categoryextensibleConsentCategoryCodes
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.typerequiredFixed Value: permit
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actor:grantor.roleextensibleSecurityRoleType
Consent.provision.actor:grantor/personnummer.roleextensibleSecurityRoleType
Consent.provision.actor:grantor/personnummer.reference.typeextensibleResourceType
Consent.provision.actor:grantor/personnummer.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:grantor/personnummer.reference.identifier.typeextensibleIdentifier Type Codes
Consent.provision.actor:grantor/samordningsnummer.roleextensibleSecurityRoleType
Consent.provision.actor:grantor/samordningsnummer.reference.typeextensibleResourceType
Consent.provision.actor:grantor/samordningsnummer.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:grantor/samordningsnummer.reference.identifier.typeextensibleIdentifier Type Codes
Consent.provision.actor:grantee.roleextensibleSecurityRoleType
Consent.provision.actor:grantee.reference.typeextensibleResourceType
Consent.provision.actor:grantee.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:grantee.reference.identifier.typeextensibleIdentifier Type Codes
Consent.provision.actor:primaryauthor.roleextensibleSecurityRoleType
Consent.provision.actor:primaryauthor.reference.typeextensibleResourceType
Consent.provision.actor:primaryauthor.reference.identifier.userequiredIdentifierUse
Consent.provision.actor:primaryauthor.reference.identifier.typeextensibleIdentifier Type Codes
Consent.provision.actionexampleConsentActionCodes
Consent.provision.securityLabelextensibleAll Security Labels
Consent.provision.purposeextensiblePurposeOfUse
Consent.provision.classextensibleConsentContentClass
Consent.provision.codeexampleConsentContentCodes (a valid code from LOINC)
Consent.provision.data.meaningrequiredConsentDataMeaning

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Consent

Summary

Mandatory: 18 elements (10 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 15 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Consent.provision.actor is sliced based on the value of value:role.coding.code (Closed)
  • The element Consent.provision.actor is sliced based on the value of value:reference.identifier.system (Closed)

 

Other representations of profile: CSV, Excel, Schematron