Skip to content

Class: Access Policy (AccessPolicy)

Limitations and/or requirements that define how a user may gain access to a particular set of data.

URI: kfi_fhir_sparks:AccessPolicy

classDiagram class AccessPolicy click AccessPolicy href "../AccessPolicy/" AccessPolicy : access_policy_code AccessPolicy --> "1..*" EnumAccessPolicyCode : access_policy_code click EnumAccessPolicyCode href "../EnumAccessPolicyCode/" AccessPolicy : access_policy_id AccessPolicy : consent_scope AccessPolicy --> "1" EnumConsentScope : consent_scope click EnumConsentScope href "../EnumConsentScope/" AccessPolicy : data_access_type AccessPolicy --> "1" EnumDataAccessType : data_access_type click EnumDataAccessType href "../EnumDataAccessType/" AccessPolicy : description AccessPolicy : disease_limitation AccessPolicy : status AccessPolicy --> "1" EnumConsentStateCodes : status click EnumConsentStateCodes href "../EnumConsentStateCodes/" AccessPolicy : website

Slots

Name Cardinality and Range Description Inheritance
access_policy_id 1
String		 Access policy communicates the limitations and/or requirements that define ho... direct
description 0..1
String		 More details associated with the given resource direct
data_access_type 1
EnumDataAccessType		 Type of access restrictions on file downloads ( open registered
website 0..1
Uri		 URL describing the entity this represents direct
consent_scope 1
EnumConsentScope		 Which of the four areas this resource covers (extensible) direct
access_policy_code 1..*
EnumAccessPolicyCode		 A classification of the type of consents found in a consent statement direct
disease_limitation 0..1
String		 Disease Use Limitations direct
status 1
EnumConsentStateCodes		 Indicates the state of the consent direct

Usages

used by used in type used
StudyMembership access_policy_id range AccessPolicy
FileLocation access_policy_id range AccessPolicy

Identifier and Mapping Information

Annotations

property value
fhir_resource https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-research-access-policy

Schema Source

  • from schema: https://carrollaboratory.github.io/kfi-fhir-input

Mappings

Mapping Type Mapped Value
self kfi_fhir_sparks:AccessPolicy
native kfi_fhir_sparks:AccessPolicy

LinkML Source

Direct

name: AccessPolicy
annotations:
  fhir_resource:
    tag: fhir_resource
    value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-research-access-policy
description: Limitations and/or requirements that define how a user may gain access
  to a particular set of data.
title: Access Policy
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
slots:
- access_policy_id
- description
- data_access_type
- website
- consent_scope
- access_policy_code
- disease_limitation
slot_usage:
  access_policy_id:
    name: access_policy_id
    description: Access policy communicates the limitations and/or requirements that
      define how a user may gain access to a particular set of data.
    identifier: true
    range: string
    required: true
attributes:
  status:
    name: status
    annotations:
      fhir_profile:
        tag: fhir_profile
        value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-research-access-policy
      fhir_element:
        tag: fhir_element
        value: status
      fhir_resource:
        tag: fhir_resource
        value: Consent
    description: Indicates the state of the consent.
    title: Status
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input/access-policy
    rank: 1000
    domain_of:
    - AccessPolicy
    range: EnumConsentStateCodes
    required: true
    multivalued: false

Induced

name: AccessPolicy
annotations:
  fhir_resource:
    tag: fhir_resource
    value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-research-access-policy
description: Limitations and/or requirements that define how a user may gain access
  to a particular set of data.
title: Access Policy
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
slot_usage:
  access_policy_id:
    name: access_policy_id
    description: Access policy communicates the limitations and/or requirements that
      define how a user may gain access to a particular set of data.
    identifier: true
    range: string
    required: true
attributes:
  status:
    name: status
    annotations:
      fhir_profile:
        tag: fhir_profile
        value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-research-access-policy
      fhir_element:
        tag: fhir_element
        value: status
      fhir_resource:
        tag: fhir_resource
        value: Consent
    description: Indicates the state of the consent.
    title: Status
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input/access-policy
    rank: 1000
    alias: status
    owner: AccessPolicy
    domain_of:
    - AccessPolicy
    range: EnumConsentStateCodes
    required: true
    multivalued: false
  access_policy_id:
    name: access_policy_id
    description: Access policy communicates the limitations and/or requirements that
      define how a user may gain access to a particular set of data.
    title: Access Policy ID
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    identifier: true
    alias: access_policy_id
    owner: AccessPolicy
    domain_of:
    - AccessPolicy
    - StudyMembership
    - FileLocation
    range: string
    required: true
    multivalued: false
  description:
    name: description
    description: More details associated with the given resource
    title: Description
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: description
    owner: AccessPolicy
    domain_of:
    - AccessPolicy
    - Practitioner
    - ResearchStudy
    - ResearchStudyCollection
    - NCPIFile
    - Family
    range: string
    required: false
  data_access_type:
    name: data_access_type
    annotations:
      fhir_profile:
        tag: fhir_profile
        value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-research-access-policy
      fhir_extension:
        tag: fhir_extension
        value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition-access-type
      fhir_resource:
        tag: fhir_resource
        value: Consent
    description: Type of access restrictions on file downloads ( open | registered
      | controlled )
    title: Access Type
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: data_access_type
    owner: AccessPolicy
    domain_of:
    - AccessPolicy
    range: EnumDataAccessType
    required: true
    multivalued: false
  website:
    name: website
    description: URL describing the entity this represents. This can include a formal
      website, such as the Entity's website, or to an online document describing the
      entity.
    title: Website
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: website
    owner: AccessPolicy
    domain_of:
    - AccessPolicy
    - ResearchStudyCollection
    range: uri
    required: false
    multivalued: false
  consent_scope:
    name: consent_scope
    annotations:
      fhir_profile:
        tag: fhir_profile
        value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-research-access-policy
      fhir_resource:
        tag: fhir_resource
        value: Consent
      fhir_element:
        tag: fhir_element
        value: scope
    description: Which of the four areas this resource covers (extensible)
    title: Consent Scope
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: consent_scope
    owner: AccessPolicy
    domain_of:
    - AccessPolicy
    range: EnumConsentScope
    required: true
    multivalued: false
  access_policy_code:
    name: access_policy_code
    annotations:
      fhir_profile:
        tag: fhir_profile
        value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-research-access-policy
      fhir_element:
        tag: fhir_element
        value: category
      fhir_resource:
        tag: fhir_resource
        value: Consent
    description: A classification of the type of consents found in a consent statement.
    title: Access Policy Code
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: access_policy_code
    owner: AccessPolicy
    domain_of:
    - AccessPolicy
    range: EnumAccessPolicyCode
    required: true
    multivalued: true
  disease_limitation:
    name: disease_limitation
    annotations:
      fhir_profile:
        tag: fhir_profile
        value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-research-access-policy
      fhir_element:
        tag: fhir_element
        value: provision.purpose
      fhir_resource:
        tag: fhir_resource
        value: Consent
    description: Disease Use Limitations
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: disease_limitation
    owner: AccessPolicy
    domain_of:
    - AccessPolicy
    range: string
    required: false
    multivalued: false