Common FHIR profile vendor collaboration
1.0.0 - release
Common FHIR profile vendor collaboration
1.0.0 - release
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 
| 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Consent | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
  identifier | 0..1 | Identifier | Identifier for this record (external references) | |
 scope | ||||
  coding | 1..1 | Coding | Code defined by a terminology system | |
 system | 1..1 | uri | Identity of the terminology system Binding: ConsentScopeCodes (extensible): Consent Scope Codes | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
| category | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval | |
| coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version | 0..1 | string | Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106/version/20220531 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 70831000052108 | |
 patient | 1..1 | Reference(PatientSEVendorLite) | Who the consent applies to | |
| dateTime | 1..1 | dateTime | When this Consent was created or indexed | |
| policy | 1..1 | BackboneElement | Policies covered by this consent | |
| uri | 1..1 | uri | Specific policy covered by this consent Fixed Value: https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/patientdatalag-2008355_sfs-2008-355 | |
| provision | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | |
| type | 1..1 | code | deny | permit Fixed Value: permit | |
| period | 1..1 | Period | Timeframe for this rule | |
 Slices for actor | 2..3 | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Unordered, Closed by value:role.coding.code | |
 Slices for actor:grantor | S | 1..1 | BackboneElement | Who|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..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GRANTOR | |
 reference | 1..1 | Reference(Patient | RelatedPerson) | Resource for the actor (or group, by role) | |
 actor:grantor/personnummer | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | |
 reference | ||||
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| system | 0..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/personnummer | |
| value | 1..1 | string | The value that is unique | |
| actor:grantor/samordningsnummer | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | |
| reference | ||||
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| system | 0..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/samordningsnummer | |
| value | 1..1 | string | The value that is unique | |
| actor:grantee | S | 1..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
 role | ||||
 coding | ||||
| system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GRANTEE | |
| reference | ||||
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19 | |
| value | 1..1 | string | The value that is unique | |
| actor:primaryauthor | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
| role | ||||
| coding | ||||
| system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/contractsignertypecodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRIMAUTH | |
| reference | 1..1 | Reference(PractitionerRole) | Resource for the actor (or group, by role) | |
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| system | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19 | |
| value | 1..1 | string | The value that is unique | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Consent.scope.coding.system | extensible | ConsentScopeCodes |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | Σ | 0..1 | Identifier | Identifier for this record (external references) Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"} |
| status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. |
| scope | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Binding: ConsentScopeCodes (extensible): Consent Scope Codes |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy |
| category | Σ | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106/version/20220531 |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 70831000052108 |
| patient | Σ | 1..1 | Reference(PatientSEVendorLite) | Who the consent applies to |
| dateTime | Σ | 1..1 | dateTime | When this Consent was created or indexed |
| policy | 1..1 | BackboneElement | Policies covered by this consent | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| uri | C | 1..1 | uri | Specific policy covered by this consent Fixed Value: https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/patientdatalag-2008355_sfs-2008-355 |
| provision | Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: permit |
| period | Σ | 1..1 | Period | Timeframe for this rule |
| Slices for actor | 2..3 | BackboneElement | Who|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..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |
| actor:grantor | S | 1..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
 reference | 1..1 | Reference(Patient | RelatedPerson) | Resource for the actor (or group, by role) | |
| actor:grantor/personnummer | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/personnummer |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| actor:grantor/samordningsnummer | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/samordningsnummer |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| actor:grantee | S | 1..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19 |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| actor:primaryauthor | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
| reference | 1..1 | Reference(PractitionerRole) | Resource for the actor (or group, by role) | |
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19 |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Consent.status | required | ConsentState |
| Consent.scope | extensible | ConsentScopeCodes |
| Consent.scope.coding.system | extensible | ConsentScopeCodes |
| Consent.category | extensible | ConsentCategoryCodes |
| Consent.provision.type | required | Fixed Value: permit |
| Consent.provision.actor.role | extensible | SecurityRoleType |
| Consent.provision.actor:grantor.role | extensible | SecurityRoleType |
| Consent.provision.actor:grantor/personnummer.role | extensible | SecurityRoleType |
| Consent.provision.actor:grantor/personnummer.reference.identifier.use | required | IdentifierUse |
| Consent.provision.actor:grantor/samordningsnummer.role | extensible | SecurityRoleType |
| Consent.provision.actor:grantor/samordningsnummer.reference.identifier.use | required | IdentifierUse |
| Consent.provision.actor:grantee.role | extensible | SecurityRoleType |
| Consent.provision.actor:grantee.reference.identifier.use | required | IdentifierUse |
| Consent.provision.actor:primaryauthor.role | extensible | SecurityRoleType |
| Consent.provision.actor:primaryauthor.reference.identifier.use | required | IdentifierUse |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
| ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..1 | Identifier | Identifier for this record (external references) Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"} | ||||
| status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | ||||
| scope | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Binding: ConsentScopeCodes (extensible): Consent Scope Codes | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| category | Σ | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106/version/20220531 | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 70831000052108 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| patient | Σ | 1..1 | Reference(PatientSEVendorLite) | Who the consent applies to | ||||
| dateTime | Σ | 1..1 | dateTime | When 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..1 | Source from which this consent is taken | |||||
| sourceAttachment | Attachment | |||||||
| sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| policy | 1..1 | BackboneElement | Policies covered by this consent | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| authority | C | 0..1 | uri | Enforcement source for policy | ||||
| uri | C | 1..1 | uri | Specific policy covered by this consent Fixed Value: https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/patientdatalag-2008355_sfs-2008-355 | ||||
| policyRule | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
| verification | Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| verified | Σ | 1..1 | boolean | Has been verified | ||||
| verifiedWith | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
| verificationDate | 0..1 | dateTime | When consent verified | |||||
| provision | Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: permit | ||||
| period | Σ | 1..1 | Period | Timeframe for this rule | ||||
| Slices for actor | 2..3 | BackboneElement | Who|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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| actor:grantor | S | 1..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GRANTOR | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| reference | 1..1 | Reference(Patient | RelatedPerson) | Resource for the actor (or group, by role) | |||||
| actor:grantor/personnummer | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/personnummer | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| actor:grantor/samordningsnummer | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/samordningsnummer | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| actor:grantee | S | 1..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GRANTEE | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19 | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| actor:primaryauthor | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/contractsignertypecodes | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRIMAUTH | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| reference | 1..1 | Reference(PractitionerRole) | Resource for the actor (or group, by role) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19 | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| action | Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
| securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| purpose | Σ | 0..* | Coding | Context 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..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
| code | Σ | 0..* | CodeableConcept | e.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..1 | Period | Timeframe for data controlled by this rule | ||||
| data | Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
| reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
| provision | 0..* | See provision (Consent) | Nested Exception Rules | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Consent.language | preferred | CommonLanguages
| ||||
| Consent.status | required | ConsentState | ||||
| Consent.scope | extensible | ConsentScopeCodes | ||||
| Consent.scope.coding.system | extensible | ConsentScopeCodes | ||||
| Consent.category | extensible | ConsentCategoryCodes | ||||
| Consent.policyRule | extensible | ConsentPolicyRuleCodes | ||||
| Consent.provision.type | required | Fixed Value: permit | ||||
| Consent.provision.actor.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:grantor.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:grantor/personnummer.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:grantor/personnummer.reference.type | extensible | ResourceType | ||||
| Consent.provision.actor:grantor/personnummer.reference.identifier.use | required | IdentifierUse | ||||
| Consent.provision.actor:grantor/personnummer.reference.identifier.type | extensible | Identifier Type Codes | ||||
| Consent.provision.actor:grantor/samordningsnummer.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:grantor/samordningsnummer.reference.type | extensible | ResourceType | ||||
| Consent.provision.actor:grantor/samordningsnummer.reference.identifier.use | required | IdentifierUse | ||||
| Consent.provision.actor:grantor/samordningsnummer.reference.identifier.type | extensible | Identifier Type Codes | ||||
| Consent.provision.actor:grantee.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:grantee.reference.type | extensible | ResourceType | ||||
| Consent.provision.actor:grantee.reference.identifier.use | required | IdentifierUse | ||||
| Consent.provision.actor:grantee.reference.identifier.type | extensible | Identifier Type Codes | ||||
| Consent.provision.actor:primaryauthor.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:primaryauthor.reference.type | extensible | ResourceType | ||||
| Consent.provision.actor:primaryauthor.reference.identifier.use | required | IdentifierUse | ||||
| Consent.provision.actor:primaryauthor.reference.identifier.type | extensible | Identifier Type Codes | ||||
| Consent.provision.action | example | ConsentActionCodes | ||||
| Consent.provision.securityLabel | extensible | All Security Labels | ||||
| Consent.provision.purpose | extensible | PurposeOfUse | ||||
| Consent.provision.class | extensible | ConsentContentClass | ||||
| Consent.provision.code | example | ConsentContentCodes (a valid code from LOINC) | ||||
| Consent.provision.data.meaning | required | ConsentDataMeaning |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must 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:
Differential View
This structure is derived from Consent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
| identifier | 0..1 | Identifier | Identifier for this record (external references) | |
| scope | ||||
| coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 1..1 | uri | Identity of the terminology system Binding: ConsentScopeCodes (extensible): Consent Scope Codes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
| category | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval | |
| coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version | 0..1 | string | Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106/version/20220531 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 70831000052108 | |
| patient | 1..1 | Reference(PatientSEVendorLite) | Who the consent applies to | |
| dateTime | 1..1 | dateTime | When this Consent was created or indexed | |
| policy | 1..1 | BackboneElement | Policies covered by this consent | |
| uri | 1..1 | uri | Specific policy covered by this consent Fixed Value: https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/patientdatalag-2008355_sfs-2008-355 | |
| provision | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | |
| type | 1..1 | code | deny | permit Fixed Value: permit | |
| period | 1..1 | Period | Timeframe for this rule | |
| Slices for actor | 2..3 | BackboneElement | Who|what controlled by this rule (or group, by role) Slice: Unordered, Closed by value:role.coding.code | |
| Slices for actor:grantor | S | 1..1 | BackboneElement | Who|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..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GRANTOR | |
| reference | 1..1 | Reference(Patient | RelatedPerson) | Resource for the actor (or group, by role) | |
| actor:grantor/personnummer | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | |
| reference | ||||
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| system | 0..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/personnummer | |
| value | 1..1 | string | The value that is unique | |
| actor:grantor/samordningsnummer | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | |
| reference | ||||
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| system | 0..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/samordningsnummer | |
| value | 1..1 | string | The value that is unique | |
| actor:grantee | S | 1..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
| role | ||||
| coding | ||||
| system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GRANTEE | |
| reference | ||||
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19 | |
| value | 1..1 | string | The value that is unique | |
| actor:primaryauthor | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
| role | ||||
| coding | ||||
| system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/contractsignertypecodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRIMAUTH | |
| reference | 1..1 | Reference(PractitionerRole) | Resource for the actor (or group, by role) | |
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| system | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19 | |
| value | 1..1 | string | The value that is unique | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Consent.scope.coding.system | extensible | ConsentScopeCodes |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Identifier for this record (external references) Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"} |
| status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. |
| scope | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Binding: ConsentScopeCodes (extensible): Consent Scope Codes |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy |
| category | Σ | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | Σ | 0..1 | string | Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106/version/20220531 |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 70831000052108 |
| patient | Σ | 1..1 | Reference(PatientSEVendorLite) | Who the consent applies to |
| dateTime | Σ | 1..1 | dateTime | When this Consent was created or indexed |
| policy | 1..1 | BackboneElement | Policies covered by this consent | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| uri | C | 1..1 | uri | Specific policy covered by this consent Fixed Value: https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/patientdatalag-2008355_sfs-2008-355 |
| provision | Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: permit |
| period | Σ | 1..1 | Period | Timeframe for this rule |
| Slices for actor | 2..3 | BackboneElement | Who|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..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |
| actor:grantor | S | 1..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
| reference | 1..1 | Reference(Patient | RelatedPerson) | Resource for the actor (or group, by role) | |
| actor:grantor/personnummer | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/personnummer |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| actor:grantor/samordningsnummer | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/samordningsnummer |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| actor:grantee | S | 1..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19 |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| actor:primaryauthor | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |
| reference | 1..1 | Reference(PractitionerRole) | Resource for the actor (or group, by role) | |
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19 |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Consent.status | required | ConsentState |
| Consent.scope | extensible | ConsentScopeCodes |
| Consent.scope.coding.system | extensible | ConsentScopeCodes |
| Consent.category | extensible | ConsentCategoryCodes |
| Consent.provision.type | required | Fixed Value: permit |
| Consent.provision.actor.role | extensible | SecurityRoleType |
| Consent.provision.actor:grantor.role | extensible | SecurityRoleType |
| Consent.provision.actor:grantor/personnummer.role | extensible | SecurityRoleType |
| Consent.provision.actor:grantor/personnummer.reference.identifier.use | required | IdentifierUse |
| Consent.provision.actor:grantor/samordningsnummer.role | extensible | SecurityRoleType |
| Consent.provision.actor:grantor/samordningsnummer.reference.identifier.use | required | IdentifierUse |
| Consent.provision.actor:grantee.role | extensible | SecurityRoleType |
| Consent.provision.actor:grantee.reference.identifier.use | required | IdentifierUse |
| Consent.provision.actor:primaryauthor.role | extensible | SecurityRoleType |
| Consent.provision.actor:primaryauthor.reference.identifier.use | required | IdentifierUse |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
| ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
| ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
| ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
| ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..1 | Identifier | Identifier for this record (external references) Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"} | ||||
| status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | ||||
| scope | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Binding: ConsentScopeCodes (extensible): Consent Scope Codes | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| category | Σ | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106/version/20220531 | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 70831000052108 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| patient | Σ | 1..1 | Reference(PatientSEVendorLite) | Who the consent applies to | ||||
| dateTime | Σ | 1..1 | dateTime | When 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..1 | Source from which this consent is taken | |||||
| sourceAttachment | Attachment | |||||||
| sourceReference | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | |||||||
| policy | 1..1 | BackboneElement | Policies covered by this consent | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| authority | C | 0..1 | uri | Enforcement source for policy | ||||
| uri | C | 1..1 | uri | Specific policy covered by this consent Fixed Value: https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/patientdatalag-2008355_sfs-2008-355 | ||||
| policyRule | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
| verification | Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| verified | Σ | 1..1 | boolean | Has been verified | ||||
| verifiedWith | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
| verificationDate | 0..1 | dateTime | When consent verified | |||||
| provision | Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: permit | ||||
| period | Σ | 1..1 | Period | Timeframe for this rule | ||||
| Slices for actor | 2..3 | BackboneElement | Who|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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| actor:grantor | S | 1..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GRANTOR | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| reference | 1..1 | Reference(Patient | RelatedPerson) | Resource for the actor (or group, by role) | |||||
| actor:grantor/personnummer | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/personnummer | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| actor:grantor/samordningsnummer | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Fixed Value: http://electronichealth.se/identifier/samordningsnummer | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| actor:grantee | S | 1..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GRANTEE | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19 | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| actor:primaryauthor | S | 0..1 | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/contractsignertypecodes | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRIMAUTH | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| reference | 1..1 | Reference(PractitionerRole) | Resource for the actor (or group, by role) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19 | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| action | Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
| securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| purpose | Σ | 0..* | Coding | Context 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..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
| code | Σ | 0..* | CodeableConcept | e.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..1 | Period | Timeframe for data controlled by this rule | ||||
| data | Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
| reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
| provision | 0..* | See provision (Consent) | Nested Exception Rules | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Consent.language | preferred | CommonLanguages
| ||||
| Consent.status | required | ConsentState | ||||
| Consent.scope | extensible | ConsentScopeCodes | ||||
| Consent.scope.coding.system | extensible | ConsentScopeCodes | ||||
| Consent.category | extensible | ConsentCategoryCodes | ||||
| Consent.policyRule | extensible | ConsentPolicyRuleCodes | ||||
| Consent.provision.type | required | Fixed Value: permit | ||||
| Consent.provision.actor.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:grantor.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:grantor/personnummer.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:grantor/personnummer.reference.type | extensible | ResourceType | ||||
| Consent.provision.actor:grantor/personnummer.reference.identifier.use | required | IdentifierUse | ||||
| Consent.provision.actor:grantor/personnummer.reference.identifier.type | extensible | Identifier Type Codes | ||||
| Consent.provision.actor:grantor/samordningsnummer.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:grantor/samordningsnummer.reference.type | extensible | ResourceType | ||||
| Consent.provision.actor:grantor/samordningsnummer.reference.identifier.use | required | IdentifierUse | ||||
| Consent.provision.actor:grantor/samordningsnummer.reference.identifier.type | extensible | Identifier Type Codes | ||||
| Consent.provision.actor:grantee.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:grantee.reference.type | extensible | ResourceType | ||||
| Consent.provision.actor:grantee.reference.identifier.use | required | IdentifierUse | ||||
| Consent.provision.actor:grantee.reference.identifier.type | extensible | Identifier Type Codes | ||||
| Consent.provision.actor:primaryauthor.role | extensible | SecurityRoleType | ||||
| Consent.provision.actor:primaryauthor.reference.type | extensible | ResourceType | ||||
| Consent.provision.actor:primaryauthor.reference.identifier.use | required | IdentifierUse | ||||
| Consent.provision.actor:primaryauthor.reference.identifier.type | extensible | Identifier Type Codes | ||||
| Consent.provision.action | example | ConsentActionCodes | ||||
| Consent.provision.securityLabel | extensible | All Security Labels | ||||
| Consent.provision.purpose | extensible | PurposeOfUse | ||||
| Consent.provision.class | extensible | ConsentContentClass | ||||
| Consent.provision.code | example | ConsentContentCodes (a valid code from LOINC) | ||||
| Consent.provision.data.meaning | required | ConsentDataMeaning |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must 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:
Other representations of profile: CSV, Excel, Schematron